org.clapper.argot

MultiValueParameter

class MultiValueParameter[T] extends Parameter[T] with MultiValueArg[T]

Class for a non-option parameter that takes a multiple values. Each instance of the parameter on the command line adds to the sequence of values associated with the parameter.

Linear Supertypes
MultiValueArg[T], Parameter[T], HasValue[T], CommandLineArgument[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MultiValueParameter
  2. MultiValueArg
  3. Parameter
  4. HasValue
  5. CommandLineArgument
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MultiValueParameter(parent: ArgotParser, valueName: String, description: String, optional: Boolean, convert: (String, Parameter[T]) ⇒ T)

    parent

    the parent parser instance that owns the parameter

    valueName

    the placeholder name for the parameter's value, for the usage message

    description

    textual description of the parameter

    optional

    whether or not the parameter is optional. Only one parameter may be optional, and it must be the last one.

    convert

    a function that will convert a string value for the parameter to an appropriate value of type T.

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. val convert: (String, Parameter[T]) ⇒ T

    a function that will convert a string value for the parameter to an appropriate value of type T.

    a function that will convert a string value for the parameter to an appropriate value of type T.

    Definition Classes
    MultiValueParameter → Parameter
  9. 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

    Definition Classes
    Parameter → HasValue
    Exceptions thrown
    ArgotConversionException

    conversion error

  10. val description: String

    textual description of the parameter

    textual description of the parameter

    Definition Classes
    MultiValueParameter → Parameter → CommandLineArgument
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. 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
  13. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  15. 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
    HasValueCommandLineArgument
  16. 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

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. 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.

    returns

    the key

    Attributes
    protected
    Definition Classes
    Parameter → CommandLineArgument
  19. 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

    Definition Classes
    Parameter → CommandLineArgument
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. var optValue: Seq[T]

    Definition Classes
    MultiValueArg
  24. val optional: Boolean

    whether or not the parameter is optional.

    whether or not the parameter is optional. Only one parameter may be optional, and it must be the last one.

    Definition Classes
    MultiValueParameter → Parameter
  25. val parent: ArgotParser

    the parent parser instance that owns the parameter

    the parent parser instance that owns the parameter

    Definition Classes
    MultiValueParameterCommandLineArgument
  26. 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
    MultiValueArgCommandLineArgument
  27. 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
    Exceptions thrown
    ArgotConversionException

    conversion error

  28. 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
    MultiValueArgHasValue
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    Parameter → AnyRef → Any
  31. 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.

    Definition Classes
    MultiValueArg
  32. val valueName: String

    the placeholder name for the parameter's value, for the usage message

    the placeholder name for the parameter's value, for the usage message

    Definition Classes
    MultiValueParameterHasValue
  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MultiValueArg[T]

Inherited from Parameter[T]

Inherited from HasValue[T]

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any

Ungrouped