org.clapper.argot

MultiValueOption

class MultiValueOption[T] extends CommandLineOption[T] with MultiValueArg[T]

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MultiValueOption
  2. MultiValueArg
  3. HasValue
  4. CommandLineOption
  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 MultiValueOption(parent: ArgotParser, names: List[String], valueName: String, description: String, convert: (String, MultiValueOption[T]) ⇒ T)

    parent

    the parent parser instance that owns the option

    names

    the list of names the option is known by

    valueName

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

    description

    textual description of the option

    convert

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

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

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

  7. 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
    MultiValueOptionHasValue
    Exceptions thrown
    ArgotConversionException

    conversion error

  8. val description: String

    textual description of the option

    textual description of the option

    Definition Classes
    MultiValueOptionCommandLineArgument
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef → Any
  13. 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
  14. 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

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. 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
    CommandLineOptionCommandLineArgument
  17. 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
    CommandLineOptionCommandLineArgument
  18. val names: List[String]

    the list of names the option is known by

    the list of names the option is known by

    Definition Classes
    MultiValueOptionCommandLineOption
  19. final def ne(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    MultiValueArg
  23. val parent: ArgotParser

    the parent parser instance that owns the option

    the parent parser instance that owns the option

    Definition Classes
    MultiValueOptionCommandLineArgument
  24. 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
  25. 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

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

    Definition Classes
    AnyRef
  28. 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
  29. 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
  30. val valueName: String

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

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

    Definition Classes
    MultiValueOptionHasValue
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MultiValueArg[T]

Inherited from HasValue[T]

Inherited from CommandLineOption[T]

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any

Ungrouped