SingleValueArg

Abstract Value Members

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

Definition Classes
HasValue
Exceptions thrown
ArgotConversionException
conversion error
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
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
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
abstract val parent: ArgotParser

The ArgotParser instance that owns this object.
The ArgotParser instance that owns this object.

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

Definition Classes
HasValue

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

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

Definition Classes
AnyRef → Any
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
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
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
SingleValueArg → CommandLineArgument
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
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
SingleValueArg → HasValue
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

trait SingleValueArg[T] extends HasValue[T]

Abstract Value Members

abstract def convertString(s: String): T

abstract val description: String

abstract def key: Any

abstract def name: String

abstract val parent: ArgotParser

abstract val valueName: String

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(o: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val hasValue: Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reset(): Unit

def setFromString(s: String): Unit

val supportsMultipleValues: Boolean

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

def toString(): String

def value: Option[T]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from HasValue[T]

Inherited from CommandLineArgument[T]

Inherited from AnyRef

Inherited from Any

Ungrouped