Class

org.rogach.scallop

NumberArgOption

Related Doc: package scallop

Permalink

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

    Permalink

    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

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

    Permalink

    The converter for this option.

    The converter for this option.

    Definition Classes
    NumberArgOptionCliOption
  8. val default: () ⇒ Option[Long]

    Permalink

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

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

    Definition Classes
    NumberArgOptionCliOption
  9. val descr: String

    Permalink

    Description for this option, for help text.

    Description for this option, for help text.

    Definition Classes
    NumberArgOptionCliOption
  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
    NumberArgOptionCliOption
  14. val hidden: Boolean

    Permalink

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

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

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

    Permalink

    Long names for this option.

    Long names for this option.

    Definition Classes
    NumberArgOptionCliOption
  18. val name: String

    Permalink

    Name for new definition, used for identification.

    Name for new definition, used for identification.

    Definition Classes
    NumberArgOptionCliOption
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  22. val required: Boolean

    Permalink

    Is this trailing argument required?

    Is this trailing argument required?

    Definition Classes
    NumberArgOptionCliOption
  23. def requiredShortNames: Nil.type

    Permalink

    Short names that were explicitly set for this option.

    Short names that were explicitly set for this option.

    Definition Classes
    NumberArgOptionCliOption
  24. def shortNames: Nil.type

    Permalink

    Short names that are suggested by option implementation.

    Short names that are suggested by option implementation.

    Definition Classes
    NumberArgOptionCliOption
  25. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    NumberArgOption → AnyRef → Any
  27. val validator: (Any) ⇒ Boolean

    Permalink

    The function that validates the parsed value.

    The function that validates the parsed value.

    Definition Classes
    NumberArgOptionCliOption
  28. final def wait(): Unit

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

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