StateBundle (LSST CCS - Buses Definition 5.0.0 API)

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. It also allows to define component level states in internal objects stored in a ConcurrentHashMap, mapped by the component's name. 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.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StateBundle`	`clone()`
`StateBundle`	`diffState(StateBundle oldState)` Finds what has changed.
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAllStatesAsStrings()` Get the Map of all the states in this StateBundle.
`<T extends Enum<T>> Enum`	`getComponentState(String component, Class<T> enumClass)` Returns the current value for the specified State of the given component.
`StateBundle`	`getComponentStateBundle(String component)` Get the StateBundle for the given component.
`<T extends Enum<T>> Map<String,Enum>`	`getComponentsWithState(Class<T> enumClass)` For the given state, get the map of components/states.
`Set<String>`	`getComponentsWithStates()` Get the Set of all internal components.
`Map<String,Enum>`	`getDecodedStates()` Get the Map of all the states that were decoded when this message was received, i.e.
`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`	`isComponentInState(String component, StateBundle stateBundle)` Check if this component is in all the states of a given StateBundle.
`<T extends Enum<T>> boolean`	`isComponentInState(String component, T state)` Check if the given component is in the specified state.
`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`	`setComponentState(String component, Enum... states)` Sets the specified state to the bundle of the given component, replacing any previous state of the same type.
`void`	`setState(Enum... states)` Sets specified states to the bundle, replacing any previous states of the same types.
`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.
  - setComponentState
```
public final void setComponentState(String component,
                                    Enum... states)
```
    Sets the specified state to the bundle of the given component, replacing any previous state of the same type.
    
    Parameters:
    
    component - The component for which to set the state
    
    states - The states 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.
  - getComponentState
```
public final <T extends Enum<T>> Enum getComponentState(String component,
                                                        Class<T> enumClass)
```
    Returns the current value for the specified State of the given component.
    
    Type Parameters:
    
    T - An Enum that defines a set of states.
    
    Parameters:
    
    component - The component for which the state is requested
    
    enumClass - The class of the Enum representing the state.
    
    Returns:
    
    The current value for the given state for the provided component.
  - 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
  - isComponentInState
```
public <T extends Enum<T>> boolean isComponentInState(String component,
                                                      T state)
```
    Check if the given component is in the specified state.
    
    Type Parameters:
    
    T - An Enum that defines a set of states.
    
    Parameters:
    
    component - The component to be tested
    
    state - The value of the Enum to check.
    
    Returns:
    
    true if the component is in the provided state
  - isComponentInState
```
public boolean isComponentInState(String component,
                                  StateBundle stateBundle)
```
    Check if this component is in all the states of a given StateBundle.
    
    Parameters:
    
    component - The component to be tested
    
    stateBundle - The StateBundle containing all the states to check.
    
    Returns:
    
    true if this StateBundle is in all the states of the provided one.
  - 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.
  - getComponentsWithStates
```
public Set<String> getComponentsWithStates()
```
    Get the Set of all internal components.
    
    Returns:
    
    The Set of components that have a state.
  - getComponentsWithState
```
public final <T extends Enum<T>> Map<String,Enum> getComponentsWithState(Class<T> enumClass)
```
    For the given state, get the map of components/states.
    
    Type Parameters:
    
    T - An Enum that defines a set of states.
    
    Parameters:
    
    enumClass - The class of the Enum representing the state.
    
    Returns:
    
    The map of components and their current state.
  - getComponentStateBundle
```
public final StateBundle getComponentStateBundle(String component)
```
    Get the StateBundle for the given component.
    
    Parameters:
    
    component - The name of the component.
    
    Returns:
    
    the StateBundle for the given component
  - getLastModified
```
public Instant getLastModified()
```
    Get the Instant of the last time the StateBundle was modified.
    
    Returns:
    
    The Instant of the last change
  - getDecodedStates
```
public Map<String,Enum> getDecodedStates()
```
    Get the Map of all the states that were decoded when this message was received, i.e. all the states for which the client had the class definition. All the other states can be fetched via the getInternalStates() method.
    
    Returns:
    
    The map of all the decoded states.
  - getAllStatesAsStrings
```
public Map<String,String> getAllStatesAsStrings()
```
    Get the Map of all the states in this StateBundle. Since it is not guaranteed that all states were decoded upon receipt we convert all the state Enums to Strings.
    
    Returns:
    
    The map of all the states as strings.
  - 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

Class StateBundle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StateBundle

Method Detail

mergeState

diffState

setComponentState

setState

getState

getComponentState

isInState

isComponentInState

isComponentInState

isInState

getComponentsWithStates

getComponentsWithState

getComponentStateBundle

getLastModified

getDecodedStates

getAllStatesAsStrings

getInternalStates

equals

hashCode

clone

toString