com.dsi.ant.plugins.antplus.pcc.defines

Enum DeviceState

java.lang.Object

java.lang.Enum<DeviceState>

com.dsi.ant.plugins.antplus.pcc.defines.DeviceState

All Implemented Interfaces:

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

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

Defines the possible states of a device.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED The device is not connected and not trying to connect but will still respond to commands.
DEAD The device is no longer usable and will not respond to commands.
PROCESSING_REQUEST The plugin is currently processing a command request from a client.
SEARCHING The device is attempting to establish a connection.
TRACKING The device has an open connection, and can receive and transmit data.
UNRECOGNIZED The value sent by the plugin service was unrecognized indicating an upgrade of the PCC may be required to handle the value.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIntValue() Convert enum to equivalent int value
static DeviceState	getValueFromInt(int intValue) Convert int to equivalent enum value
static DeviceState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DeviceState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEAD

public static final DeviceState DEAD

The device is no longer usable and will not respond to commands.

CLOSED

public static final DeviceState CLOSED

The device is not connected and not trying to connect but will still respond to commands.

SEARCHING

public static final DeviceState SEARCHING

The device is attempting to establish a connection. Note: The plugins will attempt to automatically search for lost devices. If the device is determined to no longer be present then the channel will close and the device state will change to DEAD.

TRACKING

public static final DeviceState TRACKING

The device has an open connection, and can receive and transmit data.

PROCESSING_REQUEST

public static final DeviceState PROCESSING_REQUEST

The plugin is currently processing a command request from a client.

UNRECOGNIZED

public static final DeviceState UNRECOGNIZED

The value sent by the plugin service was unrecognized indicating an upgrade of the PCC may be required to handle the value.

Method Detail

values

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

Returns:

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

valueOf

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

getIntValue

public int getIntValue()

Convert enum to equivalent int value

Returns:

integer value equivalent

getValueFromInt

public static DeviceState getValueFromInt(int intValue)

Convert int to equivalent enum value

Parameters:

intValue - integer to convert

Returns:

enum value equivalent