Package io.openems.edge.battery.soltaro.cluster.versionc.statemachine

Enum Class StateMachine.State

java.lang.Object

java.lang.Enum<StateMachine.State>

io.openems.edge.battery.soltaro.cluster.versionc.statemachine.StateMachine.State

All Implemented Interfaces:

OptionsEnum, State<StateMachine.State>, Serializable, Comparable<StateMachine.State>, Constable

Enclosing class:

StateMachine

public static enum StateMachine.State
extends Enum<StateMachine.State>
implements State<StateMachine.State>, OptionsEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR
GO_RUNNING
GO_STOPPED
RUNNING
STOPPED
UNDEFINED

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets this enums String representation.
StateMachine.State[]	getStates()	Gets all the available States.
OptionsEnum	getUndefined()	Gets the enum that is used for 'UNDEFINED' values.
int	getValue()	Gets this enums int representation.
static StateMachine.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StateMachine.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.openems.common.types.OptionsEnum

asCamelCase, isUndefined

Enum Constant Details

UNDEFINED

public static final StateMachine.State UNDEFINED

GO_RUNNING

public static final StateMachine.State GO_RUNNING

RUNNING

public static final StateMachine.State RUNNING

GO_STOPPED

public static final StateMachine.State GO_STOPPED

STOPPED

public static final StateMachine.State STOPPED

ERROR

public static final StateMachine.State ERROR

Method Details

values

public static StateMachine.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StateMachine.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Description copied from interface: OptionsEnum

Gets this enums int representation.

Specified by:

getValue in interface OptionsEnum

Returns:

the int representation

getName

public String getName()

Description copied from interface: OptionsEnum

Gets this enums String representation.

Specified by:

getName in interface OptionsEnum

Returns:

the String representation

getUndefined

public OptionsEnum getUndefined()

Description copied from interface: OptionsEnum

Gets the enum that is used for 'UNDEFINED' values.

Specified by:

getUndefined in interface OptionsEnum

Returns:

the UNDEFINED enum

getStates

public StateMachine.State[] getStates()

Description copied from interface: State

Gets all the available States.

If used inside a 'State' enum, just implement this method using

 @Override
 public State[] getStates() {
        return State.values();
 }
 

Specified by:

getStates in interface State<StateMachine.State>

Returns:

an array of States, as provided by an enum.