org.lsst.ccs.bus.states

Class StateBundle

java.lang.Object

org.lsst.ccs.bus.states.StateBundle

All Implemented Interfaces:

Serializable, Cloneable

public class StateBundle
extends Object
implements Serializable, Cloneable

Contains a set of subsystem states, each represented by Enum. States are stored internally in a ConcurrentHashMap, mapped by their class names. This class is meant to be published on the buses with every status message and when there is any state change. This class is thread safe to the extent supported by the underlying ConcurrentHashMap: no concurrent modifications are thrown, but atomicity of operations that involve reading or modifying more than one elemental state is not guaranteed.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StateBundle(Enum... states) Constructs a StateBundle from a set of states.

Method Summary

Modifier and Type	Method and Description
StateBundle	clone()
StateBundle	diffState(StateBundle oldState) Finds what has changed.
boolean	equals(Object o)
Map<String,String>	getInternalStates() Gets string representations of the internal states.
Instant	getLastModified() Get the Instant of the last time the StateBundle was modified.
<T extends Enum<T>> Enum	getState(Class<T> enumClass) Returns the current value for the specified State.
int	hashCode()
boolean	isInState(StateBundle stateBundle) Check if this StateBundle is in all the states of a given StateBundle.
<T extends Enum<T>> boolean	isInState(T state) Check if this StateBundle contains the specified state.
StateBundle	mergeState(StateBundle newState) Merge the content of two StateBundle objects returning an updated cloned version of the original StateBundle object.
void	setState(Enum... states) Sets specified states to the bundle, replacing any previous states of the same types.
void	setState(Enum state) Sets the specified state to the bundle, replacing any previous state of the same type.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StateBundle

public StateBundle(Enum... states)

Constructs a StateBundle from a set of states.

Parameters:

states - The set of States to construct the StateBundle with.

Method Detail

mergeState

public StateBundle mergeState(StateBundle newState)

Merge the content of two StateBundle objects returning an updated cloned version of the original StateBundle object. The original StateBundle is left unchanged.

Parameters:

newState - The StateBundle with the changes.

Returns:

An update cloned version of the original StateBundle.

diffState

public StateBundle diffState(StateBundle oldState)

Finds what has changed.

Parameters:

oldState - The StateBundle of the previous state .

Returns:

a new StateBundle containing only the changed states.

setState

public final void setState(Enum state)

Sets the specified state to the bundle, replacing any previous state of the same type.

Parameters:

state - The state to set on the StateBundle.

setState

public final void setState(Enum... states)

Sets specified states to the bundle, replacing any previous states of the same types.

Parameters:

states - The specified states to set on the StateBundle

getState

public final <T extends Enum<T>> Enum getState(Class<T> enumClass)

Returns the current value for the specified State.

Type Parameters:

T - An Enum that defines a set of states.

Parameters:

enumClass - The class of the Enum representing the state.

Returns:

The current value for the given state.

isInState

public <T extends Enum<T>> boolean isInState(T state)

Check if this StateBundle contains the specified state.

Type Parameters:

T - An Enum that defines a set of states.

Parameters:

state - The value of the Enum to check.

Returns:

true if this StateBundle contains the provided state

isInState

public boolean isInState(StateBundle stateBundle)

Check if this StateBundle is in all the states of a given StateBundle.

Parameters:

stateBundle - The StateBundle containing all the states to check.

Returns:

true if this StateBundle is in all the states of the provided one.

getLastModified

public Instant getLastModified()

Get the Instant of the last time the StateBundle was modified.

Returns:

The Instant of the last change

getInternalStates

public Map<String,String> getInternalStates()

Gets string representations of the internal states.

Returns:

a map of enum class name to the string value of this enum.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StateBundle clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object