com.unitech.lib.types

Enum BatteryState

java.lang.Object

java.lang.Enum<BatteryState>

com.unitech.lib.types.BatteryState

All Implemented Interfaces:

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

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

Enum representing different battery states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
charging
fullCharged
low
normal
unknown
veryLow

Method Summary

Modifier and Type	Method and Description
static BatteryState	fromValue(byte value) Returns the BatteryState enum corresponding to the given byte value.
byte	getCode() Returns the byte code of the battery state.
java.lang.String	toString() Returns the string representation of the battery state.
byte	value() Returns the byte value of the battery state.
static BatteryState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BatteryState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

charging

public static final BatteryState charging

veryLow

public static final BatteryState veryLow

low

public static final BatteryState low

normal

public static final BatteryState normal

fullCharged

public static final BatteryState fullCharged

unknown

public static final BatteryState unknown

Method Detail

values

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

Returns:

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

valueOf

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

value

public byte value()

Returns the byte value of the battery state.

Returns:

The byte value of the battery state.

getCode

public byte getCode()

Returns the byte code of the battery state.

Returns:

The byte code of the battery state.

toString

public java.lang.String toString()

Returns the string representation of the battery state.

Overrides:

toString in class java.lang.Enum<BatteryState>

Returns:

The string representation of the battery state.

fromValue

public static BatteryState fromValue(byte value)
                              throws java.lang.IllegalArgumentException

Returns the BatteryState enum corresponding to the given byte value.

Parameters:

value - The byte value to match against the BatteryState enum values.

Returns:

The BatteryState enum corresponding to the given byte value.

Throws:

java.lang.IllegalArgumentException - If the given byte value does not match any BatteryState enum value.