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
Learn more about member selection
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] = immutable.this.Nil, opts: List[CliOption] = immutable.this.Nil, mainOpts: List[String] = immutable.this.Nil, vers: Option[String] = scala.None, bann: Option[String] = scala.None, foot: Option[String] = scala.None, descr: String = "", helpWidth: Option[Int] = scala.None, shortSubcommandsHelp: Boolean = false, appendDefaultToDescription: Boolean = false, subbuilders: List[(String, Scallop)] = immutable.this.Nil, parent: Option[Scallop] = scala.None) extends Product with Serializable

    The main builder class.

  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.

  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. object ArgType extends Enumeration

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

  2. object Formatter

  3. object Scallop extends Serializable

    The creator and god of all parsers :)

  4. object TrailingArgumentsParser

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

  5. implicit val bigDecimalConverter: ValueConverter[BigDecimal]

  6. implicit val bigIntConverter: ValueConverter[BigInt]

  7. implicit val byteConverter: ValueConverter[Byte]

  8. implicit val byteListConverter: ValueConverter[List[Byte]]

  9. implicit val bytePropsConverter: ValueConverter[Map[String, Byte]]

  10. implicit val charConverter: ValueConverter[Char]

  11. implicit val charPropsConverter: ValueConverter[Map[String, Char]]

  12. implicit val doubleConverter: ValueConverter[Double]

  13. implicit val doubleListConverter: ValueConverter[List[Double]]

  14. implicit val doublePropsConverter: ValueConverter[Map[String, Double]]

  15. package exceptions

  16. implicit val fileConverter: ValueConverter[File]

  17. implicit val flagConverter: ValueConverter[Boolean]

  18. implicit val floatConverter: ValueConverter[Float]

  19. implicit val floatListConverter: ValueConverter[List[Float]]

  20. implicit val floatPropsConverter: ValueConverter[Map[String, Float]]

  21. implicit val intConverter: ValueConverter[Int]

  22. implicit val intListConverter: ValueConverter[List[Int]]

  23. implicit val intPropsConverter: ValueConverter[Map[String, Int]]

  24. def listArgConverter[A](conv: (String) ⇒ A)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[List[A]]): ValueConverter[List[A]]

  25. implicit val longConverter: ValueConverter[Long]

  26. implicit val longListConverter: ValueConverter[List[Long]]

  27. implicit val longPropsConverter: ValueConverter[Map[String, Long]]

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

  29. def optDefault[A](default: A)(implicit conv: ValueConverter[A]): ValueConverter[A]

  30. object overrideColorOutput extends DynamicVariable[Option[Boolean]]

  31. implicit val pathConverter: ValueConverter[Path]

  32. def propsConverter[A](conv: ValueConverter[A])(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[Map[String, A]]): ValueConverter[Map[String, A]]

  33. implicit val shortConverter: ValueConverter[Short]

  34. implicit val shortListConverter: ValueConverter[List[Short]]

  35. implicit val shortPropsConverter: ValueConverter[Map[String, Short]]

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

  37. implicit val stringConverter: ValueConverter[String]

  38. implicit val stringListConverter: ValueConverter[List[String]]

  39. implicit val stringPropsConverter: ValueConverter[Map[String, String]]

  40. val tallyConverter: ValueConverter[Int]

  41. object throwError extends DynamicVariable[Boolean]

    Convenience variable to permit testing.

  42. implicit val uriConverter: ValueConverter[URI]

  43. implicit val urlConverter: ValueConverter[URL]

Inherited from AnyRef

Inherited from Any

Ungrouped