csw.messages.params.states

Class CurrentState

java.lang.Object

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

csw.messages.params.states.CurrentState

All Implemented Interfaces:

ParameterSetKeyData, TMTSerializable, java.io.Serializable, scala.Equals, scala.Product

public class CurrentState
extends ParameterSetType<CurrentState>
implements ParameterSetKeyData, scala.Product, scala.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 and Description
static class	CurrentState.NameableCurrentState$

Constructor Summary

Constructors

Constructor and Description
CurrentState(StateName currentStateName, Setup command) A Java helper method to create a CurrentState from a Setup
CurrentState(java.lang.String prefix, StateName currentStateName) A Java helper method to construct with String

Method Summary

Modifier and Type	Method and Description
static <P extends Parameter<?>> T	add(P parameter)
static CurrentState	apply(Prefix prefix, StateName stateName, scala.collection.immutable.Set<Parameter<?>> paramSet) A helper method to create CurrentState
abstract static boolean	canEqual(java.lang.Object that)
static boolean	contains(Key<?> key)
protected CurrentState	create(scala.collection.immutable.Set<Parameter<?>> data) Create a new CurrentState instance when a parameter is added or removed
protected static java.lang.String	dataToString()
abstract static boolean	equals(java.lang.Object that)
static <S> boolean	exists(Key<S> key)
static <S> scala.Option<Parameter<S>>	find(Parameter<S> parameter)
static <S> scala.Option<Parameter<S>>	get(Key<S> key)
static <S> scala.Option<Parameter<S>>	get(java.lang.String keyName, KeyType<S> keyType)
static scala.collection.immutable.Map<java.lang.String,java.lang.String>	getStringMap()
static <S> java.util.Optional<Parameter<S>>	jFind(Parameter<S> parameter)
static <S> java.util.Optional<Parameter<S>>	jGet(Key<S> key)
static <S> java.util.Optional<Parameter<S>>	jGet(java.lang.String keyName, KeyType<S> keyType)
static java.util.Map<java.lang.String,java.lang.String>	jGetStringMap()
static java.util.Set<java.lang.String>	jMissingKeys(Key<?>... keys)
static java.util.Set<java.lang.String>	jMissingKeys(scala.collection.Seq<Key<?>> keys)
static java.util.Set<Parameter<?>>	jParamSet()
static <P extends Parameter<?>> T	madd(P... parametersToAdd)
static <P extends Parameter<?>> T	madd(scala.collection.Seq<P> parametersToAdd)
static <P extends Parameter<?>> T	madd(scala.collection.immutable.Set<P> parametersToAdd)
static scala.collection.immutable.Set<java.lang.String>	missingKeys(scala.collection.Seq<Key<?>> keys)
static <S> Parameter<S>	parameter(Key<S> key)
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
static java.lang.String	prefixStr()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
static <S> T	remove(Key<S> key)
static <P extends Parameter<?>> T	remove(P parameter)
static int	size()
StateName	stateName()
static Subsystem	subsystem()
static java.lang.String	toString()
static java.lang.String	typeName()

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

add, apply, contains, dataToString, exists, find, get, get, getStringMap, jFind, jGet, jGet, jGetStringMap, 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 csw.messages.params.generics.ParameterSetKeyData

prefixStr, subsystem, toString

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

CurrentState

public CurrentState(java.lang.String 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

typeName

public static java.lang.String typeName()

jParamSet

public static java.util.Set<Parameter<?>> jParamSet()

size

public static int size()

add

public static <P extends Parameter<?>> T add(P parameter)

madd

public static <P extends Parameter<?>> T madd(scala.collection.Seq<P> parametersToAdd)

madd

public static <P extends Parameter<?>> T madd(scala.collection.immutable.Set<P> parametersToAdd)

get

public static <S> scala.Option<Parameter<S>> get(Key<S> key)

jGet

public static <S> java.util.Optional<Parameter<S>> jGet(Key<S> key)

get

public static <S> scala.Option<Parameter<S>> get(java.lang.String keyName,
                                                 KeyType<S> keyType)

jGet

public static <S> java.util.Optional<Parameter<S>> jGet(java.lang.String keyName,
                                                        KeyType<S> keyType)

find

public static <S> scala.Option<Parameter<S>> find(Parameter<S> parameter)

jFind

public static <S> java.util.Optional<Parameter<S>> jFind(Parameter<S> parameter)

parameter

public static final <S> Parameter<S> parameter(Key<S> key)

exists

public static <S> boolean exists(Key<S> key)

remove

public static <S> T remove(Key<S> key)

remove

public static <P extends Parameter<?>> T remove(P parameter)

dataToString

protected static java.lang.String dataToString()

toString

public static java.lang.String toString()

contains

public static boolean contains(Key<?> key)

missingKeys

public static scala.collection.immutable.Set<java.lang.String> missingKeys(scala.collection.Seq<Key<?>> keys)

jMissingKeys

public static java.util.Set<java.lang.String> jMissingKeys(scala.collection.Seq<Key<?>> keys)

getStringMap

public static scala.collection.immutable.Map<java.lang.String,java.lang.String> getStringMap()

jGetStringMap

public static java.util.Map<java.lang.String,java.lang.String> jGetStringMap()

madd

public static <P extends Parameter<?>> T madd(P... parametersToAdd)

jMissingKeys

public static java.util.Set<java.lang.String> jMissingKeys(Key<?>... keys)

subsystem

public static final Subsystem subsystem()

prefixStr

public static final java.lang.String prefixStr()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

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

Returns:

(undocumented)

stateName

public StateName stateName()

paramSet

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

Description copied from class: ParameterSetType

Holds the parameters for this parameter set

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