p

org.rogach

scallop

package scallop

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

Type Members

  1. sealed trait CliOption extends AnyRef
  2. class LazyMap [A, +B] extends Map[A, B]

    A class, that lazily encapsulates a map inside.

  3. case class LongNamedPropertyOption (name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
  4. case class NumberArgOption (name: String, required: Boolean, descr: String, converter: ValueConverter[Long], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Long], hidden: Boolean) extends CliOption with Product with Serializable
  5. case class PropertyOption (name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
  6. 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, subbuilders: List[(String, Scallop)] = Nil, parent: Option[Scallop] = None) extends 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

  7. abstract class ScallopConf extends ScallopConfValidations
  8. trait ScallopConfValidations extends AnyRef

    Helper trait for generaton of validate methods on ScallopConf.

  9. 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.

  10. case class SimpleOption (name: String, short: Option[Char], descr: String, required: Boolean, converter: ValueConverter[_], default: () ⇒ Option[Any], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, argName: String, hidden: Boolean, noshort: Boolean) extends CliOption with Product with Serializable
  11. class Subcommand extends ScallopConf
  12. 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
  13. case class TrailingArgsOption (name: String, required: Boolean, descr: String, converter: ValueConverter[_], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Any], hidden: Boolean) extends CliOption with Product with Serializable
  14. trait ValueConverter [A] extends AnyRef

    Converter from list of plain strings to something meaningful.

Value Members

  1. implicit val bigDecimalConverter: ValueConverter[BigDecimal]
  2. implicit val bigIntConverter: ValueConverter[BigInt]
  3. implicit val byteConverter: ValueConverter[Byte]
  4. implicit val byteListConverter: ValueConverter[List[Byte]]
  5. implicit val bytePropsConverter: ValueConverter[Map[String, Byte]]
  6. implicit val charConverter: ValueConverter[Char]
  7. implicit val charPropsConverter: ValueConverter[Map[String, Char]]
  8. implicit val doubleConverter: ValueConverter[Double]
  9. implicit val doubleListConverter: ValueConverter[List[Double]]
  10. implicit val doublePropsConverter: ValueConverter[Map[String, Double]]
  11. implicit val fileConverter: ValueConverter[File]
  12. implicit val flagConverter: ValueConverter[Boolean]
  13. implicit val floatConverter: ValueConverter[Float]
  14. implicit val floatListConverter: ValueConverter[List[Float]]
  15. implicit val floatPropsConverter: ValueConverter[Map[String, Float]]
  16. implicit val intConverter: ValueConverter[Int]
  17. implicit val intListConverter: ValueConverter[List[Int]]
  18. implicit val intPropsConverter: ValueConverter[Map[String, Int]]
  19. def listArgConverter[A](conv: (String) ⇒ A)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[List[A]]): ValueConverter[List[A]]
  20. implicit val longConverter: ValueConverter[Long]
  21. implicit val longListConverter: ValueConverter[List[Long]]
  22. implicit val longPropsConverter: ValueConverter[Map[String, Long]]
  23. 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

  24. def optDefault[A](default: A)(implicit conv: ValueConverter[A]): ValueConverter[A]
  25. implicit val pathConverter: ValueConverter[Path]
  26. def propsConverter[A](conv: ValueConverter[A])(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[Map[String, A]]): ValueConverter[Map[String, A]]
  27. implicit val shortConverter: ValueConverter[Short]
  28. implicit val shortListConverter: ValueConverter[List[Short]]
  29. implicit val shortPropsConverter: ValueConverter[Map[String, Short]]
  30. def singleArgConverter[A](conv: (String) ⇒ A, handler: PartialFunction[Throwable, Either[String, Option[A]]] = PartialFunction.empty)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[A]): 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

  31. implicit val stringConverter: ValueConverter[String]
  32. implicit val stringListConverter: ValueConverter[List[String]]
  33. implicit val stringPropsConverter: ValueConverter[Map[String, String]]
  34. val tallyConverter: ValueConverter[Int]
  35. implicit val uriConverter: ValueConverter[URI]
  36. implicit val urlConverter: ValueConverter[URL]
  37. object ArgType extends Enumeration

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

  38. object Formatter
  39. object Scallop extends Serializable

    The creator and god of all parsers :)

  40. 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.

  41. object overrideColorOutput extends DynamicVariable[Option[Boolean]]
  42. object throwError extends DynamicVariable[Boolean]

    Convenience variable to permit testing.

Inherited from AnyRef

Inherited from Any

Ungrouped