Class

org.rogach.scallop

PropertyOption

Related Doc: package scallop

Permalink

case class PropertyOption(name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable

Descriptor for a property option (like -Dkey=value or -D key1=value1 key2=value2).

name

Internal name for the option.

short

Character that will be used as prefix for property arguments.

descr

Description for this property option, for help description.

converter

The converter for this option.

keyName

Name for 'key' part of this option arg name, as it will appear in help option definition.

valueName

Name for 'value' part of this option arg name, as it will appear in help option definition.

hidden

If set to true, then this option will be hidden from generated help output.

Source
CliOptions.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, CliOption, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PropertyOption
  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 PropertyOption(name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean)

    Permalink

    name

    Internal name for the option.

    short

    Character that will be used as prefix for property arguments.

    descr

    Description for this property option, for help description.

    converter

    The converter for this option.

    keyName

    Name for 'key' part of this option arg name, as it will appear in help option definition.

    valueName

    Name for 'value' part of this option arg name, as it will appear in help option definition.

    hidden

    If set to true, then this option will be hidden from generated help output.

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

  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. val converter: ValueConverter[_]

    Permalink

    The converter for this option.

    The converter for this option.

    Definition Classes
    PropertyOption → CliOption

  8. def default: () ⇒ Some[Map[Nothing, Nothing]]

    Permalink

    Function that provides an optional default value for this option.

    Function that provides an optional default value for this option.

    Definition Classes
    PropertyOption → CliOption

  9. val descr: String

    Permalink

    Description for this property option, for help description.

    Description for this property option, for help description.

    Definition Classes
    PropertyOption → CliOption

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

    Permalink
    Definition Classes
    AnyRef

  11. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. 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
    PropertyOption → CliOption

  14. val hidden: Boolean

    Permalink

    If set to true, then this option will be hidden from generated help output.

    If set to true, then this option will be hidden from generated help output.

    Definition Classes
    PropertyOption → CliOption

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. 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
    PropertyOption → CliOption

  17. val keyName: String

    Permalink

    Name for 'key' part of this option arg name, as it will appear in help option definition.

  18. def longNames: Nil.type

    Permalink

    Long names for this option.

    Long names for this option.

    Definition Classes
    PropertyOption → CliOption

  19. val name: String

    Permalink

    Internal name for the option.

    Internal name for the option.

    Definition Classes
    PropertyOption → CliOption

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. 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
    PropertyOption → CliOption

  24. 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
    PropertyOption → CliOption

  25. val short: Char

    Permalink

    Character that will be used as prefix for property arguments.

  26. def shortNames: List[Char]

    Permalink

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    PropertyOption → CliOption

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

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    PropertyOption → AnyRef → Any

  29. def validator: (Any) ⇒ Boolean

    Permalink

    Validator for the option value.

    Validator for the option value.

    Definition Classes
    PropertyOption → CliOption

  30. val valueName: String

    Permalink

    Name for 'value' part of this option arg name, as it will appear in help option definition.

  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