org.flexiblepower.ral.drivers.battery

Enum BatteryMode

java.lang.Object

java.lang.Enum<BatteryMode>

org.flexiblepower.ral.drivers.battery.BatteryMode

All Implemented Interfaces:

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

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

To represent the different modes a battery can be in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHARGE When the battery is charging (taking energy from the net).
DISCHARGE When the battery is discharging (providing energy to the net).
IDLE When the battery is idle (no interaction with the net).

Method Summary

Methods

Modifier and Type	Method and Description
static BatteryMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BatteryMode[]	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

IDLE

public static final BatteryMode IDLE

When the battery is idle (no interaction with the net).

CHARGE

public static final BatteryMode CHARGE

When the battery is charging (taking energy from the net).

DISCHARGE

public static final BatteryMode DISCHARGE

When the battery is discharging (providing energy to the net).

Method Detail

values

public static BatteryMode[] 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 (BatteryMode c : BatteryMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BatteryMode 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