org.clapper.argot

SingleValueParameter

class SingleValueParameter [T] extends Parameter[T] with SingleValueArg[T]

Class for a non-option parameter that takes a single value.

Linear Supertypes
SingleValueArg[T], Parameter[T], HasValue[T], CommandLineArgument[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SingleValueParameter
  2. SingleValueArg
  3. Parameter
  4. HasValue
  5. CommandLineArgument
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SingleValueParameter (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 last one

    convert

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

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. 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
    SingleValueParameter → 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
  10. val description : String

    textual description of the parameter

    textual description of the parameter

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

    Attributes
    final
    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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def getClass (): java.lang.Class[_]

    Attributes
    final
    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. def isInstanceOf [T0] : Boolean

    Attributes
    final
    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. def ne (arg0: AnyRef): Boolean

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  23. 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 last one

    Definition Classes
    SingleValueParameter → Parameter
  24. val parent : ArgotParser

    the parent parser instance that owns the parameter

    the parent parser instance that owns the parameter

    Definition Classes
    SingleValueParameterCommandLineArgument
  25. 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
    SingleValueArgCommandLineArgument
  26. 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
  27. 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
    SingleValueArgHasValue
  28. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  29. def toString (): String

    Definition Classes
    Parameter → AnyRef → Any
  30. def value : Option[T]

    Get the option's value.

    Get the option's value.

    returns

    Some(value) if the value is set; None if not.

    Definition Classes
    SingleValueArg
  31. 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
    SingleValueParameterHasValue
  32. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from SingleValueArg[T]

Inherited from Parameter[T]

Inherited from HasValue[T]

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any