Trait

org.rogach.scallop

CliOption

Related Doc: package scallop

Permalink

sealed trait CliOption extends AnyRef

Parent class for option descriptors. Each option descriptor contains everything needed to parse that option - option names, defaults, converters, validators, etc.

Source
CliOptions.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CliOption
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def argLine(sh: List[Char]): String

    Permalink

    The line that would be printed as definition of this arg in help output.

  2. abstract def converter: ValueConverter[_]

    Permalink

    Converter for pure string arguments to the needed type of this option.

  3. abstract def default: () ⇒ Option[Any]

    Permalink

    Function that provides an optional default value for this option.

  4. abstract def descr: String

    Permalink

    Description for this option that will be presented to the user

  5. abstract def helpInfo(sh: List[Char]): List[HelpInfo]

    Permalink

    List of argument lines, descriptions to them, and optional default values.

  6. abstract def hidden: Boolean

    Permalink

    If true, then this option is not shown in help output.

  7. abstract def isPositional: Boolean

    Permalink

    True for trailing argument option type, false for everything else.

  8. abstract def longNames: List[String]

    Permalink

    Long names for this option.

  9. abstract def name: String

    Permalink

    Internal name of this option - the one that would be used to access parsed values.

  10. abstract def required: Boolean

    Permalink

    Is there a requirement to have at least one invocation of this option?

  11. abstract def requiredShortNames: List[Char]

    Permalink

    Short names that were explicitly set for this option.

  12. abstract def shortNames: List[Char]

    Permalink

    Short names that are suggested by option implementation.

  13. abstract def validator: (Any) ⇒ Boolean

    Permalink

    Validator for the option value.

Concrete 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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped