Package csw.params.core.states

Class CurrentState

java.lang.Object

csw.params.core.generics.ParameterSetType<CurrentState>

csw.params.core.states.CurrentState

All Implemented Interfaces:

ParameterSetKeyData, StateVariable, CommandSerializable, java.io.Serializable, scala.Equals, scala.Product

public class CurrentState
extends ParameterSetType<CurrentState>
implements ParameterSetKeyData, StateVariable, scala.Product, java.io.Serializable

A state variable that indicates the ''current'' or actual state.

param: prefix identifies the target subsystem param: stateName identifies the name of the state param: paramSet an optional initial set of items (keys with values)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CurrentState.NameableCurrentState$

Constructor Summary

Constructors

Constructor	Description
CurrentState(StateName currentStateName, Setup command)	A Java helper method to create a CurrentState from a Setup
CurrentState(Prefix prefix, StateName currentStateName)	A Java helper method to construct with String
CurrentState(Prefix prefix, StateName stateName, scala.collection.immutable.Set<Parameter<?>> paramSet)

Method Summary

Modifier and Type	Method	Description
static CurrentState	apply(Prefix prefix, StateName stateName, scala.collection.immutable.Set<Parameter<?>> paramSet)	A helper method to create CurrentState
protected CurrentState	create(scala.collection.immutable.Set<Parameter<?>> data)	Create a new CurrentState instance when a parameter is added or removed
scala.collection.immutable.Set<Parameter<?>>	paramSet()	Holds the parameters for this parameter set
Prefix	prefix()	Returns an object providing the subsystem and prefix for the parameter set
StateName	stateName()	identifies the name of the state

Methods inherited from class csw.params.core.generics.ParameterSetType

add, apply, contains, dataToString, exists, find, get, get, getStringMap, jFind, jGet, jGet, jGetStringMap, jMadd, jMissingKeys, jMissingKeys, jParamSet, madd, madd, madd, missingKeys, parameter, remove, remove, size, toString, typeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface csw.params.core.generics.ParameterSetKeyData

prefixStr, subsystem, toString

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface csw.params.core.states.StateVariable

toString, typeName

Constructor Detail

CurrentState

public CurrentState(Prefix prefix,
                    StateName stateName,
                    scala.collection.immutable.Set<Parameter<?>> paramSet)

CurrentState

public CurrentState(Prefix prefix,
                    StateName currentStateName)

A Java helper method to construct with String

Parameters:

prefix - (undocumented)

currentStateName - (undocumented)

CurrentState

public CurrentState(StateName currentStateName,
                    Setup command)

A Java helper method to create a CurrentState from a Setup

Parameters:

currentStateName - (undocumented)

command - (undocumented)

Method Detail

apply

public static CurrentState apply(Prefix prefix,
                                 StateName stateName,
                                 scala.collection.immutable.Set<Parameter<?>> paramSet)

A helper method to create CurrentState

Parameters:

prefix - identifies the target subsystem

stateName - identifies the name of the state

paramSet - an optional initial set of items (keys with values)

Returns:

an instance of CurrentState

prefix

public Prefix prefix()

Description copied from interface: ParameterSetKeyData

Returns an object providing the subsystem and prefix for the parameter set

Specified by:

prefix in interface ParameterSetKeyData

Specified by:

prefix in interface StateVariable

Returns:

(undocumented)

stateName

public StateName stateName()

Description copied from interface: StateVariable

identifies the name of the state

Specified by:

stateName in interface StateVariable

Returns:

(undocumented)

paramSet

public scala.collection.immutable.Set<Parameter<?>> paramSet()

Description copied from class: ParameterSetType

Holds the parameters for this parameter set

Specified by:

paramSet in interface StateVariable

Specified by:

paramSet in class ParameterSetType<CurrentState>

Returns:

(undocumented)

create

protected CurrentState create(scala.collection.immutable.Set<Parameter<?>> data)

Create a new CurrentState instance when a parameter is added or removed

Specified by:

create in class ParameterSetType<CurrentState>

Parameters:

data - set of parameters

Returns:

a new instance of CurrentState with provided data