Package net.solarnetwork.domain

Enum Class DeviceOperatingState

java.lang.Object

java.lang.Enum<DeviceOperatingState>

net.solarnetwork.domain.DeviceOperatingState

All Implemented Interfaces:

Serializable, Comparable<DeviceOperatingState>, Constable, Bitmaskable

public enum DeviceOperatingState
extends Enum<DeviceOperatingState>
implements Bitmaskable

An enumeration of standardized device operating states.

Since:

1.50

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface net.solarnetwork.domain.Bitmaskable

Bitmaskable.BitmaskableTypeSort

Enum Constant Summary

Enum Constants

Enum Constant	Description
Disabled	A disabled state.
Fault	A faulty state.
Normal	Normal operating state.
Override	An overridden state.
Recovery	A recovery state.
Shutdown	A shutdown/off state.
Standby	A standby/low power state.
Starting	A startup/initializing state.
Unknown	An unknown state.

Field Summary

Fields inherited from interface net.solarnetwork.domain.Bitmaskable

SORT_BY_TYPE

Method Summary

Modifier and Type	Method	Description
int	bitmaskBitOffset()	Get the bit offset.
static DeviceOperatingState	forCode(int code)	Get an enum for a code value.
int	getCode()	Get the code for this condition.
static DeviceOperatingState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DeviceOperatingState[]	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

Enum Constant Details

Unknown

public static final DeviceOperatingState Unknown

An unknown state.

Normal

public static final DeviceOperatingState Normal

Normal operating state.

Starting

public static final DeviceOperatingState Starting

A startup/initializing state.

Standby

public static final DeviceOperatingState Standby

A standby/low power state.

Shutdown

public static final DeviceOperatingState Shutdown

A shutdown/off state.

Fault

public static final DeviceOperatingState Fault

A faulty state.

Disabled

public static final DeviceOperatingState Disabled

A disabled state.

Recovery

public static final DeviceOperatingState Recovery

A recovery state.

Override

public static final DeviceOperatingState Override

An overridden state.

Method Details

values

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

getCode

public int getCode()

Get the code for this condition.

Returns:

the code

bitmaskBitOffset

public int bitmaskBitOffset()

Description copied from interface: Bitmaskable

Get the bit offset.

Specified by:

bitmaskBitOffset in interface Bitmaskable

Returns:

offset, starting from 0 for the right-most bit

forCode

public static DeviceOperatingState forCode(int code)

Get an enum for a code value.

Parameters:

code - the code to get an enum for

Returns:

the enum with the given code, or null if code is 0

Throws:

IllegalArgumentException - if code is not supported