p

org.rogach

scallop

package scallop

Source
package.scala
Linear Supertypes
DefaultConverters, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. scallop
  2. DefaultConverters
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Package Members

  1. package exceptions

Type Members

  1. sealed trait CliOption extends AnyRef
  2. trait DefaultConverters extends AnyRef
  3. case class HelpInfo(argLine: String, description: String, defaultValue: () => Option[String]) extends Product with Serializable
  4. class LazyMap[A, +B] extends Map[A, B]

    A class, that lazily encapsulates a map inside.

  5. case class LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
  6. case class NumberArgOption(name: String, required: Boolean, descr: String, converter: ValueConverter[Long], validator: (Any) => Boolean, default: () => Option[Long], hidden: Boolean) extends CliOption with Product with Serializable
  7. case class PropertyOption(name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
  8. case class Scallop(args: Seq[String] = Nil, opts: List[CliOption] = Nil, mainOpts: List[String] = Nil, vers: Option[String] = None, bann: Option[String] = None, foot: Option[String] = None, descr: String = "", helpWidth: Option[Int] = None, shortSubcommandsHelp: Boolean = false, appendDefaultToDescription: Boolean = false, helpFormatter: ScallopHelpFormatter = new ScallopHelpFormatter, subbuilders: List[(String, Scallop)] = Nil) extends ScallopArgListLoader with Product with Serializable

    The main builder class.

    The main builder class.

    args

    Arguments to parse.

    opts

    Options definitions.

    mainOpts

    Names of options, that are to be printed first in the help printout

    vers

    Version string to display in help.

    bann

    Banner (summary of this program and command-line usage) to display in help.

    foot

    Footer - displayed after options.

    descr

    Short description - used for subcommands

    helpWidth

    Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)

    shortSubcommandsHelp

    If true, then help output from this builder wouldn't list full help for subcommands, only short description

    subbuilders

    subcommands in this builder

  9. trait ScallopArgListLoader extends AnyRef
  10. abstract class ScallopConf extends ScallopConfBase
  11. abstract class ScallopConfBase extends ScallopConfValidations
  12. trait ScallopConfValidations extends AnyRef

    Helper trait for generaton of validate methods on ScallopConf.

  13. class ScallopHelpFormatter extends AnyRef
  14. abstract class ScallopOption[A] extends AnyRef

    A class to hold a reference to not-yet-computed option values.

    A class to hold a reference to not-yet-computed option values.

    Basically, this is a lazy option - it batches up all operations, and evaluates the value only as the last resort.

  15. trait Serialization extends Serializable

    Use this trait to make your ScallopConf serializable.

    Use this trait to make your ScallopConf serializable. Warning: this serialization method expects your ScallopConf class to have public constructor that accepts Seq[String] or List[String] as a single parameter.

    If your class does not have such constructor, you will need to implement serialization/deserialization logic yourself (see https://github.com/scallop/scallop/issues/137)

  16. class SerializationProxy extends Serializable
  17. case class SimpleOption(name: String, short: Option[Char], descr: String, required: Boolean, converter: ValueConverter[_], default: () => Option[Any], validator: (Any) => Boolean, argName: String, hidden: Boolean, noshort: Boolean) extends CliOption with Product with Serializable
  18. class Subcommand extends ScallopConf
  19. case class ToggleOption(name: String, default: () => Option[Boolean], short: Option[Char], noshort: Boolean, prefix: String, descrYes: String, descrNo: String, hidden: Boolean) extends CliOption with Product with Serializable
  20. case class TrailingArgsOption(name: String, required: Boolean, descr: String, converter: ValueConverter[_], validator: (Any) => Boolean, default: () => Option[Any], hidden: Boolean) extends CliOption with Product with Serializable
  21. trait ValueConverter[A] extends AnyRef

    Converter from list of plain strings to something meaningful.

Value Members

  1. implicit val bigDecimalConverter: ValueConverter[BigDecimal]
    Definition Classes
    DefaultConverters
  2. implicit val bigIntConverter: ValueConverter[BigInt]
    Definition Classes
    DefaultConverters
  3. implicit val byteConverter: ValueConverter[Byte]
    Definition Classes
    DefaultConverters
  4. implicit val byteListConverter: ValueConverter[List[Byte]]
    Definition Classes
    DefaultConverters
  5. implicit val bytePropsConverter: ValueConverter[Map[String, Byte]]
    Definition Classes
    DefaultConverters
  6. implicit val charConverter: ValueConverter[Char]
    Definition Classes
    DefaultConverters
  7. implicit val charPropsConverter: ValueConverter[Map[String, Char]]
    Definition Classes
    DefaultConverters
  8. implicit val doubleConverter: ValueConverter[Double]
    Definition Classes
    DefaultConverters
  9. implicit val doubleListConverter: ValueConverter[List[Double]]
    Definition Classes
    DefaultConverters
  10. implicit val doublePropsConverter: ValueConverter[Map[String, Double]]
    Definition Classes
    DefaultConverters
  11. implicit val durationConverter: ValueConverter[Duration]
    Definition Classes
    DefaultConverters
  12. implicit val fileConverter: ValueConverter[File]
  13. implicit val fileListConverter: ValueConverter[List[File]]
  14. implicit val finiteDurationConverter: ValueConverter[FiniteDuration]
    Definition Classes
    DefaultConverters
  15. implicit val flagConverter: ValueConverter[Boolean]
    Definition Classes
    DefaultConverters
  16. implicit val floatConverter: ValueConverter[Float]
    Definition Classes
    DefaultConverters
  17. implicit val floatListConverter: ValueConverter[List[Float]]
    Definition Classes
    DefaultConverters
  18. implicit val floatPropsConverter: ValueConverter[Map[String, Float]]
    Definition Classes
    DefaultConverters
  19. implicit val intConverter: ValueConverter[Int]
    Definition Classes
    DefaultConverters
  20. implicit val intListConverter: ValueConverter[List[Int]]
    Definition Classes
    DefaultConverters
  21. implicit val intPropsConverter: ValueConverter[Map[String, Int]]
    Definition Classes
    DefaultConverters
  22. def listArgConverter[A](conv: (String) => A): ValueConverter[List[A]]
    Definition Classes
    DefaultConverters
  23. implicit val longConverter: ValueConverter[Long]
    Definition Classes
    DefaultConverters
  24. implicit val longListConverter: ValueConverter[List[Long]]
    Definition Classes
    DefaultConverters
  25. implicit val longPropsConverter: ValueConverter[Map[String, Long]]
    Definition Classes
    DefaultConverters
  26. def numberHandler[T](name: String): PartialFunction[Throwable, Either[String, Option[T]]]

    Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.

    Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.

    name

    the type name to display

    Definition Classes
    DefaultConverters
  27. def optDefault[A](default: A)(implicit conv: ValueConverter[A]): ValueConverter[A]
    Definition Classes
    DefaultConverters
  28. implicit val pathConverter: ValueConverter[Path]
  29. def propsConverter[A](conv: ValueConverter[A]): ValueConverter[Map[String, A]]
    Definition Classes
    DefaultConverters
  30. implicit val shortConverter: ValueConverter[Short]
    Definition Classes
    DefaultConverters
  31. implicit val shortListConverter: ValueConverter[List[Short]]
    Definition Classes
    DefaultConverters
  32. implicit val shortPropsConverter: ValueConverter[Map[String, Short]]
    Definition Classes
    DefaultConverters
  33. def singleArgConverter[A](conv: (String) => A, handler: PartialFunction[Throwable, Either[String, Option[A]]] = PartialFunction.empty): ValueConverter[A]

    Create a converter for an argument with a single value.

    Create a converter for an argument with a single value.

    conv

    the conversion function to use, which may throw an exception on error

    handler

    an error handler function for writing custom error messages

    Definition Classes
    DefaultConverters
  34. implicit val stringConverter: ValueConverter[String]
    Definition Classes
    DefaultConverters
  35. implicit val stringListConverter: ValueConverter[List[String]]
    Definition Classes
    DefaultConverters
  36. implicit val stringPropsConverter: ValueConverter[Map[String, String]]
    Definition Classes
    DefaultConverters
  37. val tallyConverter: ValueConverter[Int]
    Definition Classes
    DefaultConverters
  38. implicit val uriConverter: ValueConverter[URI]
  39. implicit val urlConverter: ValueConverter[URL]
  40. object ArgType

    An enumeration of possible arg types by number of arguments they can take.

  41. object Formatter
  42. object TrailingArgumentsParser

    Parses the trailing arguments (including the arguments to last option).

    Parses the trailing arguments (including the arguments to last option). Uses simple backtraking algorithm.

  43. object Util
  44. object overrideColorOutput extends DynamicVariable[Option[Boolean]]
  45. object throwError extends DynamicVariable[Boolean]

    Convenience variable to permit testing.

Inherited from DefaultConverters

Inherited from AnyRef

Inherited from Any

Ungrouped