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
- Alphabetic
- By Inheritance
- ToggleOption
- Serializable
- Product
- Equals
- CliOption
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- val default: () => Option[Boolean]
Function that provides an optional default value for this option.
Function that provides an optional default value for this option.
- Definition Classes
- ToggleOption → CliOption
- 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
- val descrNo: String
- val descrYes: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- val hidden: Boolean
If true, then this option is not shown in help output.
If true, then this option is not shown in help output.
- Definition Classes
- ToggleOption → CliOption
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- def longNames: List[String]
Long names for this option.
Long names for this option.
- Definition Classes
- ToggleOption → CliOption
- val name: String
Internal name of this option - the one that would be used to access parsed values.
Internal name of this option - the one that would be used to access parsed values.
- Definition Classes
- ToggleOption → CliOption
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noshort: Boolean
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val prefix: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val required: Boolean
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
- ToggleOption → CliOption
- 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
- val short: Option[Char]
- def shortNames: List[Char]
Short names that are suggested by option implementation.
Short names that are suggested by option implementation.
- Definition Classes
- ToggleOption → CliOption
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ToggleOption → AnyRef → Any
- def validator: (Any) => Boolean
Validator for the option value.
Validator for the option value.
- Definition Classes
- ToggleOption → CliOption
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()