org.clapper.argot

CommandLineOption

trait CommandLineOption[T] extends CommandLineArgument[T]

CommandLineOption is the base trait for all option classes.

T

the value type

See also

MultiValueOption

SingleValueOption

Linear Supertypes
CommandLineArgument[T], AnyRef, Any
Known Subclasses
FlagOption, MultiValueOption, SingleValueOption
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommandLineOption
  2. CommandLineArgument
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val description: String

    The argument's description, displayed in the usage message.

    The argument's description, displayed in the usage message.

    Definition Classes
    CommandLineArgument

  2. abstract val hasValue: Boolean

    Whether or not the argument has an associated value.

    Whether or not the argument has an associated value. For instance, parameters have values, and non-flag options have values. Flag options, however, do not.

    Definition Classes
    CommandLineArgument

  3. abstract val names: List[String]

    List of option names, both long (multi-character) and short (single-character).

  4. abstract val parent: ArgotParser

    The ArgotParser instance that owns this object.

    The ArgotParser instance that owns this object.

    Definition Classes
    CommandLineArgument

  5. abstract def reset(): Unit

    Resets the internal state of the argument to what it was right after construction, undoing the effects of any parse operation.

    Resets the internal state of the argument to what it was right after construction, undoing the effects of any parse operation.

    Definition Classes
    CommandLineArgument

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(o: Any): Boolean

    The standard equals() method.

    The standard equals() method.

    o

    some other object

    returns

    true if the other object is the same class and is equivalent, false if not.

    Definition Classes
    CommandLineArgument → AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Calculate the hash code for the object.

    Calculate the hash code for the object. The default implementation returns the hash code of the key.

    returns

    the hash code

    Definition Classes
    CommandLineArgument → AnyRef → Any
    See also

    #key

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. def key: String

    Return an object that represents the key for this parameter, suitable for hashing, sorting, etc.

    Return an object that represents the key for this parameter, suitable for hashing, sorting, etc. They key for a command line option is the result of calling name().

    returns

    the key

    Attributes
    protected
    Definition Classes
    CommandLineOption → CommandLineArgument

  15. def name: String

    Return a suitable name for the option.

    Return a suitable name for the option. The returned name will have a "-" or "--" prefix, depending on whether it's long or short. It will be based on the first option in the list of option names.

    returns

    the option name

    Definition Classes
    CommandLineOption → CommandLineArgument

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Get a printable name for this object.

    Get a printable name for this object.

    returns

    the printable name

    Definition Classes
    CommandLineOption → AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any

Ungrouped