Class

org.rogach.scallop

ToggleOption

Related Doc: package scallop

Permalink

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

Descriptor for a toggle option (like --verbose/--noverbose).

name

Name of this option.

default

Default value for this option.

short

Overload the char that will be used as short option name.

noshort

If set to true, then this option will not have any short name.

prefix

Prefix to name of the option, that will be used for "negative" version of the option.

descrYes

Description for positive variant of this option.

descrNo

Description for negative variant of this option.

hidden

If set to true, then this option will not be present in auto-generated help.

Source
CliOptions.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, CliOption, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToggleOption
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CliOption
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ToggleOption(name: String, default: () ⇒ Option[Boolean], short: Option[Char], noshort: Boolean, prefix: String, descrYes: String, descrNo: String, hidden: Boolean)

    Permalink

    name

    Name of this option.

    default

    Default value for this option.

    short

    Overload the char that will be used as short option name.

    noshort

    If set to true, then this option will not have any short name.

    prefix

    Prefix to name of the option, that will be used for "negative" version of the option.

    descrYes

    Description for positive variant of this option.

    descrNo

    Description for negative variant of this option.

    hidden

    If set to true, then this option will not be present in auto-generated help.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def argLine(sh: List[Char]): String

    Permalink

    The line that would be printed as definition of this arg in help output.

    The line that would be printed as definition of this arg in help output.

    Definition Classes
    ToggleOptionCliOption
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def converter: ValueConverter[Boolean]

    Permalink

    Converter for pure string arguments to the needed type of this option.

    Converter for pure string arguments to the needed type of this option.

    Definition Classes
    ToggleOptionCliOption
  8. val default: () ⇒ Option[Boolean]

    Permalink

    Default value for this option.

    Default value for this option.

    Definition Classes
    ToggleOptionCliOption
  9. def descr: String

    Permalink

    Description for this option that will be presented to the user

    Description for this option that will be presented to the user

    Definition Classes
    ToggleOptionCliOption
  10. val descrNo: String

    Permalink

    Description for negative variant of this option.

  11. val descrYes: String

    Permalink

    Description for positive variant of this option.

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def helpInfo(sh: List[Char]): List[HelpInfo]

    Permalink

    List of argument lines, descriptions to them, and optional default values.

    List of argument lines, descriptions to them, and optional default values.

    Definition Classes
    ToggleOptionCliOption
  16. val hidden: Boolean

    Permalink

    If set to true, then this option will not be present in auto-generated help.

    If set to true, then this option will not be present in auto-generated help.

    Definition Classes
    ToggleOptionCliOption
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def isPositional: Boolean

    Permalink

    True for trailing argument option type, false for everything else.

    True for trailing argument option type, false for everything else.

    Definition Classes
    ToggleOptionCliOption
  19. def longNames: List[String]

    Permalink

    Long names for this option.

    Long names for this option.

    Definition Classes
    ToggleOptionCliOption
  20. val name: String

    Permalink

    Name of this option.

    Name of this option.

    Definition Classes
    ToggleOptionCliOption
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. val noshort: Boolean

    Permalink

    If set to true, then this option will not have any short name.

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val prefix: String

    Permalink

    Prefix to name of the option, that will be used for "negative" version of the option.

  26. def required: Boolean

    Permalink

    Is there a requirement to have at least one invocation of this option?

    Is there a requirement to have at least one invocation of this option?

    Definition Classes
    ToggleOptionCliOption
  27. def requiredShortNames: List[Char]

    Permalink

    Short names that were explicitly set for this option.

    Short names that were explicitly set for this option.

    Definition Classes
    ToggleOptionCliOption
  28. val short: Option[Char]

    Permalink

    Overload the char that will be used as short option name.

  29. def shortNames: List[Char]

    Permalink

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    ToggleOptionCliOption
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    ToggleOption → AnyRef → Any
  32. def validator: (Any) ⇒ Boolean

    Permalink

    Validator for the option value.

    Validator for the option value.

    Definition Classes
    ToggleOptionCliOption
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CliOption

Inherited from AnyRef

Inherited from Any

Ungrouped