eu.hgross.blaubot.core

Enum State

java.lang.Object

java.lang.Enum<State>

eu.hgross.blaubot.core.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<State>

public enum State
extends java.lang.Enum<State>

Enum constants wiring together some classes related to device states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Free
King
Peasant
Prince
Stopped

Method Summary

Modifier and Type	Method and Description
AbstractBlaubotDeviceDiscoveryEvent	createDiscoveryEventForDevice(IBlaubotDevice device, java.util.List<ConnectionMetaDataDTO> connectionMetaDataList) Creates the appropriate discovery event from the given State
static State	getStateByStatemachineClass(java.lang.Class<? extends IBlaubotState> stateClass)
java.lang.Class<? extends IBlaubotState>	getStateClass()
boolean	isStateChangeAllowed(State toState) Checks if a transition to "toState" is allowed from "this" state.
static State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Free

public static final State Free

Peasant

public static final State Peasant

Prince

public static final State Prince

King

public static final State King

Stopped

public static final State Stopped

Method Detail

values

public static State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (State c : State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static State valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getStateClass

public java.lang.Class<? extends IBlaubotState> getStateClass()

getStateByStatemachineClass

public static State getStateByStatemachineClass(java.lang.Class<? extends IBlaubotState> stateClass)

Parameters:

stateClass - a class that is used by sthe state machine

Returns:

state enum or null, if no state is mapped to this stateClass

createDiscoveryEventForDevice

public AbstractBlaubotDeviceDiscoveryEvent createDiscoveryEventForDevice(IBlaubotDevice device,
                                                                         java.util.List<ConnectionMetaDataDTO> connectionMetaDataList)

Creates the appropriate discovery event from the given State

Parameters:

device - the device associated with this state

connectionMetaDataList - the meta data for the acceptors of `device`

Returns:

the discovery event for the given device

isStateChangeAllowed

public boolean isStateChangeAllowed(State toState)

Checks if a transition to "toState" is allowed from "this" state.

Parameters:

toState - the state to check

Returns:

true iff a state change from 'this' state to 'toState' is allowed.