c

org.rogach.scallop

LongNamedPropertyOption

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

Descriptor for a property option with a "long" name (like --Props key1=value1 key2=value2).

name

Internal name for the option.

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, Product, Equals, CliOption, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LongNamedPropertyOption
  2. Serializable
  3. Product
  4. Equals
  5. CliOption
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean)

    name

    Internal name for the option.

    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
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
    LongNamedPropertyOptionCliOption
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val converter: ValueConverter[_]

    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
    LongNamedPropertyOptionCliOption
  8. def default: () => Some[Map[Nothing, Nothing]]

    Function that provides an optional default value for this option.

    Function that provides an optional default value for this option.

    Definition Classes
    LongNamedPropertyOptionCliOption
  9. val 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
    LongNamedPropertyOptionCliOption
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. 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
    LongNamedPropertyOptionCliOption
  14. 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
    LongNamedPropertyOptionCliOption
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. 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
    LongNamedPropertyOptionCliOption
  17. val keyName: String
  18. def longNames: List[String]

    Long names for this option.

    Long names for this option.

    Definition Classes
    LongNamedPropertyOptionCliOption
  19. 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
    LongNamedPropertyOptionCliOption
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def 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
    LongNamedPropertyOptionCliOption
  25. def requiredShortNames: Nil

    Short names that were explicitly set for this option.

    Short names that were explicitly set for this option.

    Definition Classes
    LongNamedPropertyOptionCliOption
  26. def shortNames: Nil

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    LongNamedPropertyOptionCliOption
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    LongNamedPropertyOption → AnyRef → Any
  29. def validator: (Any) => Boolean

    Validator for the option value.

    Validator for the option value.

    Definition Classes
    LongNamedPropertyOptionCliOption
  30. val valueName: String
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CliOption

Inherited from AnyRef

Inherited from Any

Ungrouped