org.rogach.scallop

ToggleOption

case class ToggleOption(name: String, default: () ⇒ Option[Boolean], short: Option[Char], noshort: Boolean, prefix: String, descrYes: String, descrNo: String, required: Boolean, 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.

required

Is this option required?

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
Learn more about member selection
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, required: Boolean, hidden: Boolean)

    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.

    required

    Is this option required?

    hidden

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

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def argLine(sh: List[Char]): String

    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
    ToggleOption → CliOption

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def converter: ValueConverter[Boolean]

    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
    ToggleOption → CliOption

  10. val default: () ⇒ Option[Boolean]

    Default value for this option.

    Default value for this option.

    Definition Classes
    ToggleOption → CliOption

  11. def descr: String

    Description for this option that will be presented to the user

    Description for this option that will be presented to the user

    Definition Classes
    ToggleOption → CliOption

  12. val descrNo: String

    Description for negative variant of this option.

  13. val descrYes: String

    Description for positive variant of this option.

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

    Definition Classes
    AnyRef

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def helpInfo(sh: List[Char]): List[HelpInfo]

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

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

    Definition Classes
    ToggleOption → CliOption

  18. val hidden: Boolean

    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
    ToggleOption → CliOption

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  20. def isPositional: Boolean

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

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

    Definition Classes
    ToggleOption → CliOption

  21. def longNames: List[String]

    Long names for this option.

    Long names for this option.

    Definition Classes
    ToggleOption → CliOption

  22. val name: String

    Name of this option.

    Name of this option.

    Definition Classes
    ToggleOption → CliOption

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  24. val noshort: Boolean

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

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. val prefix: String

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

  28. val required: Boolean

    Is this option required?

    Is this option required?

    Definition Classes
    ToggleOption → CliOption

  29. def requiredShortNames: List[Char]

    Short names that were explicitly set for this option.

    Short names that were explicitly set for this option.

    Definition Classes
    ToggleOption → CliOption

  30. val short: Option[Char]

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

  31. def shortNames: List[Char]

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    ToggleOption → CliOption

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  33. def toString(): String

    Definition Classes
    ToggleOption → AnyRef → Any

  34. def validator: (Any) ⇒ Boolean

    Validator for the option value.

    Validator for the option value.

    Definition Classes
    ToggleOption → CliOption

  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long): Unit

    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