org.clapper.argot

CommandLineArgument

Related Doc: package argot

trait CommandLineArgument[T] extends AnyRef

Base trait for all option and parameter classes, CommandLineArgument contains comment methods and values.

T

the type associated with the argument

Linear Supertypes
AnyRef, Any
Known Subclasses
CommandLineOption, FlagOption, HasValue, MultiValueArg, MultiValueOption, MultiValueParameter, SingleValueArg, SingleValueOption, SingleValueParameter
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommandLineArgument
  2. AnyRef
  3. 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.

  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.

  3. abstract def key: Any

    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.

    returns

    the key

    Attributes
    protected

  4. abstract def name: String

    Displayable name for the argument, used in the usage message.

    Displayable name for the argument, used in the usage message.

    returns

    the name

  5. abstract val parent: ArgotParser

    The ArgotParser instance that owns this object.

  6. 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.

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

    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  7. 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

  8. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  10. 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

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  16. def toString(): String

    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped