Package io.openems.edge.battery.protection.force

Enum AbstractForceChargeDischarge.State

java.lang.Object

java.lang.Enum<AbstractForceChargeDischarge.State>

io.openems.edge.battery.protection.force.AbstractForceChargeDischarge.State

All Implemented Interfaces:

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

Enclosing class:

AbstractForceChargeDischarge

public static enum AbstractForceChargeDischarge.State
extends java.lang.Enum<AbstractForceChargeDischarge.State>
implements State<AbstractForceChargeDischarge.State>, OptionsEnum

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK_MODE
FORCE_MODE
UNDEFINED
WAIT_FOR_FORCE_MODE

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Gets this enums String representation.
AbstractForceChargeDischarge.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 AbstractForceChargeDischarge.State	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AbstractForceChargeDischarge.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

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

asCamelCase, isUndefined

Enum Constant Detail

UNDEFINED

public static final AbstractForceChargeDischarge.State UNDEFINED

WAIT_FOR_FORCE_MODE

public static final AbstractForceChargeDischarge.State WAIT_FOR_FORCE_MODE

FORCE_MODE

public static final AbstractForceChargeDischarge.State FORCE_MODE

BLOCK_MODE

public static final AbstractForceChargeDischarge.State BLOCK_MODE

Method Detail

values

public static AbstractForceChargeDischarge.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 (AbstractForceChargeDischarge.State c : AbstractForceChargeDischarge.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 AbstractForceChargeDischarge.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

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 java.lang.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 AbstractForceChargeDischarge.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<AbstractForceChargeDischarge.State>

Returns:

an array of States, as provided by an enum.