c

org.rogach.scallop

NumberArgOption

case class NumberArgOption(name: String, required: Boolean, descr: String, converter: ValueConverter[Long], validator: (Any) => Boolean, default: () => Option[Long], hidden: Boolean) extends CliOption with Product with Serializable

Descriptor for a number option (-1 or -3, like GNU tail for example).

name

Name for new definition, used for identification.

required

Is this trailing argument required?

descr

Description for this option, for help text.

converter

The converter for this option.

validator

The function that validates the parsed value.

default

If this argument is not required and not found in the argument list, use this value.

hidden

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

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

    name

    Name for new definition, used for identification.

    required

    Is this trailing argument required?

    descr

    Description for this option, for help text.

    converter

    The converter for this option.

    validator

    The function that validates the parsed value.

    default

    If this argument is not required and not found in the argument list, use this value.

    hidden

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

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
    NumberArgOptionCliOption
  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[Long]

    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
    NumberArgOptionCliOption
  8. val default: () => Option[Long]

    Function that provides an optional default value for this option.

    Function that provides an optional default value for this option.

    Definition Classes
    NumberArgOptionCliOption
  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
    NumberArgOptionCliOption
  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
    NumberArgOptionCliOption
  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
    NumberArgOptionCliOption
  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
    NumberArgOptionCliOption
  17. def longNames: Nil

    Long names for this option.

    Long names for this option.

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

    Short names that were explicitly set for this option.

    Short names that were explicitly set for this option.

    Definition Classes
    NumberArgOptionCliOption
  25. def shortNames: Nil

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    NumberArgOptionCliOption
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    NumberArgOption → AnyRef → Any
  28. val validator: (Any) => Boolean

    Validator for the option value.

    Validator for the option value.

    Definition Classes
    NumberArgOptionCliOption
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. 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