org.clapper.argot

MultiValueArg

trait MultiValueArg [T] extends HasValue[T]

MultiValueArg is a refinement of the HasValue trait, specifically for arguments (options or parameters) that take multiple values of type T. Each instance of the parameter on the command line adds to the sequence of values in associated MultiValueArg object.

This trait exists primarily as a place for shared logic and values for the option- and parameter-specific subclasses.

T

the value type

See also

MultiValueParameter

,

MultiValueOption

Linear Supertypes
HasValue[T], CommandLineArgument[T], AnyRef, Any
Known Subclasses
MultiValueOption, MultiValueParameter
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MultiValueArg
  2. HasValue
  3. CommandLineArgument
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def convertString (s: String): T

    Method that converts a string value to type T.

    Method that converts a string value to type T. Should throw ArgotConversionException on error.

    s

    the string to convert

    returns

    the converted result

    Attributes
    abstract
    Definition Classes
    HasValue

  2. val description : String

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

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

    Attributes
    abstract
    Definition Classes
    CommandLineArgument

  3. 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 abstract
    Definition Classes
    CommandLineArgument

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

    Attributes
    abstract
    Definition Classes
    CommandLineArgument

  5. val parent : ArgotParser

    The ArgotParser instance that owns this object.

    The ArgotParser instance that owns this object.

    Attributes
    abstract
    Definition Classes
    CommandLineArgument

  6. val valueName : String

    All options and values with parameters must have a placeholder name for the value, used in generating the usage message.

    All options and values with parameters must have a placeholder name for the value, used in generating the usage message.

    Attributes
    abstract
    Definition Classes
    HasValue

Concrete Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

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

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  12. val hasValue : Boolean

    Always true, indicating that HasValue classes always have an associated value.

    Always true, indicating that HasValue classes always have an associated value.

    Definition Classes
    HasValue → CommandLineArgument

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

  14. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  15. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  17. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  18. var optValue : Seq[T]

  19. 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
    MultiValueArg → CommandLineArgument

  20. def setFromString (s: String): Unit

    Given a string value, convert the value to type T by calling convert(), then store it by calling storeValue().

    Given a string value, convert the value to type T by calling convert(), then store it by calling storeValue().

    s

    the string to convert

    Definition Classes
    HasValue

  21. val supportsMultipleValues : Boolean

    Whether or not the class supports multiple values (e.

    Whether or not the class supports multiple values (e.g., a sequence) or just one.

    Definition Classes
    MultiValueArg → HasValue

  22. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  23. def toString (): String

    Definition Classes
    AnyRef → Any

  24. def value : Seq[T]

    Get the option's value(s).

    Get the option's value(s).

    returns

    a sequence of option values, or Nil if none were present.

  25. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  27. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from HasValue[T]

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any