Package io.openems.edge.common.startstop

Enum Class StartStop

java.lang.Object

java.lang.Enum<StartStop>

io.openems.edge.common.startstop.StartStop

All Implemented Interfaces:

OptionsEnum, Serializable, Comparable<StartStop>, Constable

public enum StartStop
extends Enum<StartStop>
implements 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
START	START.
STOP	STOP.
UNDEFINED	UNDEFINED.

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets this enums String representation.
OptionsEnum	getUndefined()	Gets the enum that is used for 'UNDEFINED' values.
int	getValue()	Gets this enums int representation.
static StartStop	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StartStop[]	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 StartStop UNDEFINED

UNDEFINED.

• Write: set the Component to an UNDEFINED/initial state
• Read: the Component is in an UNDEFINED start/stop state

START

public static final StartStop START

START.

• Write: START the Component.
• Read: the Component is STARTED.

STOP

public static final StartStop STOP

STOP.

• Write: STOP the Component.
• Read: the Component is STOPPED.

Method Details

values

public static StartStop[] 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 StartStop 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