SwitchesElement

A concrete CliElement class representing a set of switches.

A single parameter on the command line can contain multiple switches, e.g. if multiple short keys are composed, as in tar xvzf. Therefore, this class holds a list with switches that have been extracted. For each switch its key and its value (which is derived from the default value defined in the parameter model) is stored.

Note: The properties for key and value are dummies; during parameter parsing, for each switch in the result, a new element is created.

switches: a list with switches and their values that have been extracted
index: the index of this element on the command line

Linear Supertypes

Serializable, Serializable, Product, Equals, CliElement, AnyRef, Any

Instance Constructors

new SwitchesElement(switches: List[(ParameterKey, String)], index: Int = 0)

switches
a list with switches and their values that have been extracted
index
the index of this element on the command line

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val index: Int

the index of this element on the command line
the index of this element on the command line

Definition Classes
SwitchesElement → CliElement
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def key: ParameterKey

Returns the key used for this parameter value on the command line.
Returns the key used for this parameter value on the command line. While values are stored under the main parameter key, this method allows determining the key the user has specified (which may be an alias).
returns
the key used for this CliElement

Definition Classes
SwitchesElement → CliElement
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val switches: List[(ParameterKey, String)]

a list with switches and their values that have been extracted
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def value: String

Returns the raw value of this CliElement as specified by the user.
Returns the raw value of this CliElement as specified by the user. The value may be transformed during the extraction phase. If transformation fails, it might be useful to have the original value to construct an error message.
returns
the value of this CliElement

Definition Classes
SwitchesElement → CliElement
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package ParameterParser

case class SwitchesElement(switches: List[(ParameterKey, String)], index: Int = 0) extends CliElement with Product with Serializable

Instance Constructors

new SwitchesElement(switches: List[(ParameterKey, String)], index: Int = 0)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

final def getClass(): Class[_]

val index: Int

final def isInstanceOf[T0]: Boolean

def key: ParameterKey

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val switches: List[(ParameterKey, String)]

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

def value: String

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CliElement

Inherited from AnyRef

Inherited from Any

Ungrouped