Enum 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>
,java.io.Serializable
,java.lang.Comparable<StateMachine.State>
- Enclosing class:
- StateMachine
public static enum StateMachine.State extends java.lang.Enum<StateMachine.State> implements State<StateMachine.State>, OptionsEnum
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ERROR
GO_RUNNING
GO_STOPPED
RUNNING
STOPPED
UNDEFINED
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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(java.lang.String name)
Returns the enum constant of this type with the specified name.static StateMachine.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 interface io.openems.common.types.OptionsEnum
asCamelCase, isUndefined
-
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static StateMachine.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 (StateMachine.State c : StateMachine.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 StateMachine.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 namejava.lang.NullPointerException
- if the argument is null
-
getValue
public int getValue()
Description copied from interface:OptionsEnum
Gets this enums int representation.- Specified by:
getValue
in interfaceOptionsEnum
- Returns:
- the int representation
-
getName
public java.lang.String getName()
Description copied from interface:OptionsEnum
Gets this enums String representation.- Specified by:
getName
in interfaceOptionsEnum
- 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 interfaceOptionsEnum
- 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 interfaceState<StateMachine.State>
- Returns:
- an array of States, as provided by an enum.
-
-