ModelContext

Instance Constructors

new ModelContext(options: Map[ParameterKey, ParameterAttributes], inputs: SortedSet[InputParameterRef], aliasMapping: AliasMapping, optCurrentKey: Option[ParameterKey], groups: List[String])

options
a map storing the data available for the single options
inputs
a set with data about input parameters
aliasMapping
the object with information about aliases
optCurrentKey
a key to the option that is currently defined
groups
a list with the currently active group names

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
def addAlias(alias: ParameterKey): ModelContext

Returns an updated ModelContext with a an AliasMapping that is modified to contain the new alias provided for the current key.
Returns an updated ModelContext with a an AliasMapping that is modified to contain the new alias provided for the current key.
alias
the new alias for this key
returns
the updated ModelContext
def addAttribute[A <: AnyRef](attrKey: ParameterAttributeKey[A], value: A): ModelContext

Adds an attribute for the current option.
Adds an attribute for the current option. This function is called by CliExtractor objects to add more detailed information about a command line option. It refers to the last option that has been added.
A
the data type of the attribute
attrKey
the key of the attribute
value
the value of the attribute
returns
the updated ModelContext
def addInputParameter(index: Int, optKey: Option[String], text: Option[String]): ModelContext

Adds data about an input parameter to this object.
Adds data about an input parameter to this object. This function works similar to addOption(), but creates additional information to keep track on the order of these parameters.
index
the index of the input parameter
optKey
the optional key; if it is undefined, a key is generated
text
an optional help text
returns
the updated ModelContext
def addOption(key: ParameterKey, text: Option[String]): ModelContext

Adds data about another command line option to this object.
Adds data about another command line option to this object. This function creates a new ParameterAttributes instance and initializes it from the parameters passed in. It returns a new ModelContext object whose data map contains this new instance. If there is already an entry for this parameter key, it is merged with the data passed to this function.
key
the parameter key
text
an optional help text
returns
the updated ModelContext
val aliasMapping: AliasMapping

the object with information about aliases
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def endGroup(): ModelContext

Notifies this context that a group has been processed.
Notifies this context that a group has been processed. The name of the current group is removed.
returns
the updated ModelContext
def endGroupConditionally(optGroupName: Option[String]): ModelContext

Notifies this context that a group has potentially been processed.
Notifies this context that a group has potentially been processed. If the given Option with the group name is defined, the name of the current group is removed; otherwise, this context is returned unchanged.
optGroupName
the Option with the group name
returns
the updated ModelContext or the same one
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hasAttribute(key: ParameterKey, attrKey: ParameterAttributeKey[_]): Boolean

Checks whether the command line option with the given key has a specific attribute set.
Checks whether the command line option with the given key has a specific attribute set. Only the presence of the attribute is checked, not the concrete value.
key
the key of the parameter
attrKey
the key of the attribute
returns
a flag whether this attribute is present for this option; if the option cannot be resolved, result is false
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val inputs: SortedSet[InputParameterRef]

a set with data about input parameters
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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 options: Map[ParameterKey, ParameterAttributes]

a map storing the data available for the single options
def parameterMetaData: Iterable[ParameterMetaData]

Returns an Iterable with the ParameterMetaData stored in this object.
Returns an Iterable with the ParameterMetaData stored in this object.
This implementation returns data about all the parameters defined by the application.
returns
an Iterable with the ParameterMetaData available

Definition Classes
ModelContext → ParameterMetaDataSource
def startGroup(groupName: String): ModelContext

Notifies this context about the start of a new group.
Notifies this context about the start of a new group. New options that are added later are assigned to this group.
groupName
the name of the group
returns
the updated ModelContext
def startGroupConditionally(optGroupName: Option[String]): ModelContext

Notifies this context about a potential start of a new group.
Notifies this context about a potential start of a new group. If the group name is defined, a new group is started; otherwise, the same context is returned.
optGroupName
the optional group name
returns
the updated ModelContext or the same one
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 ParameterModel

class ModelContext extends ParameterMetaDataSource

Instance Constructors

new ModelContext(options: Map[ParameterKey, ParameterAttributes], inputs: SortedSet[InputParameterRef], aliasMapping: AliasMapping, optCurrentKey: Option[ParameterKey], groups: List[String])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAlias(alias: ParameterKey): ModelContext

def addAttribute[A <: AnyRef](attrKey: ParameterAttributeKey[A], value: A): ModelContext

def addInputParameter(index: Int, optKey: Option[String], text: Option[String]): ModelContext

def addOption(key: ParameterKey, text: Option[String]): ModelContext

val aliasMapping: AliasMapping

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def endGroup(): ModelContext

def endGroupConditionally(optGroupName: Option[String]): ModelContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hasAttribute(key: ParameterKey, attrKey: ParameterAttributeKey[_]): Boolean

def hashCode(): Int

val inputs: SortedSet[InputParameterRef]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: Map[ParameterKey, ParameterAttributes]

def parameterMetaData: Iterable[ParameterMetaData]

def startGroup(groupName: String): ModelContext

def startGroupConditionally(optGroupName: Option[String]): ModelContext

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

def toString(): 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 ParameterMetaDataSource

Inherited from AnyRef

Inherited from Any

Ungrouped