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

A class to collect any number of State information. It is designed to accept any state in the form of an Enum. It will be stored internally in a HashMap using the class of the Enum as key. So at any given point this class will store the current value of all the provided states. This class is meant to be published on the buses with every status message and when there is any state change.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StateBundle	clone()
boolean	equals(Object o) MT: Commented out.
<T extends Enum<T>> Enum	getState(Class<T> enumClass) Get the current value for a given State by providing the class of the Enum representing the 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 a given Enum state.
StateBundle	mergeState(StateBundle newState) Merge the content of two StateBundle objects returning an updated cloned version of the original StateBundle object.
<T extends Enum<T>> void	setState(T state) Set the value of a state in the form of an Enum value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StateBundle

public StateBundle(Enum... states)

Construct a StateBundle from a set of states.

Parameters:

states - A set of states.

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.

Parameters:

newState - The StateBundle with the changes.

Returns:

An update cloned version of the original StateBundle.

setState

public final <T extends Enum<T>> void setState(T state)

Set the value of a state in the form of an Enum value. The value will be stored in a HashMap with the Enum's class as key.

Type Parameters:

T - An enum that defines a set of states.

Parameters:

state - The current value for the state.

getState

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

Get the current value for a given State by providing the class of the Enum representing the 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 a given Enum 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.

equals

public boolean equals(Object o)

MT: Commented out. What is the return value if the StateBundle Does not have the provided state? getState would return null. How would it compare?

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