com.dsi.ant.message

Enum ChannelState

java.lang.Object

java.lang.Enum<ChannelState>

com.dsi.ant.message.ChannelState

All Implemented Interfaces:

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

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

The possible states an ANT channel can be in.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASSIGNED Ready to be configured and then opened.
INVALID Received state does not match possible states.
SEARCHING Open and searching for devices with matching channel ID
TRACKING Found and connected to a device.
UNASSIGNED Not configured and closed.

Method Summary

Methods

Modifier and Type	Method and Description
static ChannelState	create(int rawValue) Creates the channel state from a raw value.
int	getRawValue() Returns the raw value for this channel state.
static ChannelState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelState[]	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

UNASSIGNED

public static final ChannelState UNASSIGNED

Not configured and closed.

Since:

4.0

ASSIGNED

public static final ChannelState ASSIGNED

Ready to be configured and then opened.

Since:

4.0

SEARCHING

public static final ChannelState SEARCHING

Open and searching for devices with matching channel ID

Since:

4.0

TRACKING

public static final ChannelState TRACKING

Found and connected to a device.

Since:

4.0

INVALID

public static final ChannelState INVALID

Received state does not match possible states.

Since:

4.0

Method Detail

values

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

Returns:

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

valueOf

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

getRawValue

public int getRawValue()

Returns the raw value for this channel state. Applications should use the enumeration values directly.

Returns:

The raw value.

Since:

4.0

create

public static ChannelState create(int rawValue)

Creates the channel state from a raw value. Applications should use the enumeration values directly.

Parameters:

rawValue - The raw value.

Returns:

The channel state.

Since:

4.0