org.clapper.argot

HasValue

Related Doc: package argot

trait HasValue[T] extends CommandLineArgument[T]

The HasValue trait is mixed into option and parameter classes that support one or mor associated values of type T.

T

the value type

See also

MultiValueArg

SingleValueArg

Linear Supertypes
CommandLineArgument[T], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HasValue
  2. CommandLineArgument
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Exceptions thrown

    ArgotConversionException conversion error

  2. abstract val description: String

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

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

    Definition Classes
    CommandLineArgument
  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
    Definition Classes
    CommandLineArgument
  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

    Definition Classes
    CommandLineArgument
  5. abstract val parent: ArgotParser

    The ArgotParser instance that owns this object.

    The ArgotParser instance that owns this object.

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

    Resets the internal state of the argument to what it was right after construction, undoing the effects of any parse operation.

    Definition Classes
    CommandLineArgument
  7. abstract val supportsMultipleValues: Boolean

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

  8. abstract val valueName: String

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

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

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  16. 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

    Exceptions thrown

    ArgotConversionException conversion error

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

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any

Ungrouped