Class

org.rogach.scallop

SimpleOption

Related Doc: package scallop

Permalink

case class SimpleOption(name: String, short: Option[Char], descr: String, required: Boolean, converter: ValueConverter[_], default: () ⇒ Option[Any], validator: (Any) ⇒ Boolean, argName: String, hidden: Boolean, noshort: Boolean) extends CliOption with Product with Serializable

Descriptor for a simple option - describes flag, one-arg or multi-arg options (--opt [ARGS]...).

name

Name for new option, used as long option name in parsing, and for option identification.

short

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

descr

Description for this option, for help output.

required

Is this option required?

converter

The converter for this option.

default

Default value to use if option is not found in input arguments.

validator

The function that validates the parsed value.

argName

The name for this option argument, as it will appear in help.

hidden

Hides description of this option from help (this can be useful for debugging options).

noshort

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

Source
CliOptions.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, CliOption, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleOption
  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 SimpleOption(name: String, short: Option[Char], descr: String, required: Boolean, converter: ValueConverter[_], default: () ⇒ Option[Any], validator: (Any) ⇒ Boolean, argName: String, hidden: Boolean, noshort: Boolean)

    Permalink

    name

    Name for new option, used as long option name in parsing, and for option identification.

    short

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

    descr

    Description for this option, for help output.

    required

    Is this option required?

    converter

    The converter for this option.

    default

    Default value to use if option is not found in input arguments.

    validator

    The function that validates the parsed value.

    argName

    The name for this option argument, as it will appear in help.

    hidden

    Hides description of this option from help (this can be useful for debugging options).

    noshort

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

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
    SimpleOptionCliOption
  5. val argName: String

    Permalink

    The name for this option argument, as it will appear in help.

  6. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val converter: ValueConverter[_]

    Permalink

    The converter for this option.

    The converter for this option.

    Definition Classes
    SimpleOptionCliOption
  9. val default: () ⇒ Option[Any]

    Permalink

    Default value to use if option is not found in input arguments.

    Default value to use if option is not found in input arguments.

    Definition Classes
    SimpleOptionCliOption
  10. val descr: String

    Permalink

    Description for this option, for help output.

    Description for this option, for help output.

    Definition Classes
    SimpleOptionCliOption
  11. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. 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
    SimpleOptionCliOption
  15. val hidden: Boolean

    Permalink

    Hides description of this option from help (this can be useful for debugging options).

    Hides description of this option from help (this can be useful for debugging options).

    Definition Classes
    SimpleOptionCliOption
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. 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
    SimpleOptionCliOption
  18. def longNames: List[String]

    Permalink

    Long names for this option.

    Long names for this option.

    Definition Classes
    SimpleOptionCliOption
  19. val name: String

    Permalink

    Name for new option, used as long option name in parsing, and for option identification.

    Name for new option, used as long option name in parsing, and for option identification.

    Definition Classes
    SimpleOptionCliOption
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. val noshort: Boolean

    Permalink

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

  22. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  24. val required: Boolean

    Permalink

    Is this option required?

    Is this option required?

    Definition Classes
    SimpleOptionCliOption
  25. 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
    SimpleOptionCliOption
  26. val short: Option[Char]

    Permalink

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

  27. def shortNames: List[Char]

    Permalink

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    SimpleOptionCliOption
  28. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    SimpleOption → AnyRef → Any
  30. val validator: (Any) ⇒ Boolean

    Permalink

    The function that validates the parsed value.

    The function that validates the parsed value.

    Definition Classes
    SimpleOptionCliOption
  31. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. 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