Package com.dsi.ant.message
Enum Class ChannelState
- All Implemented Interfaces:
Serializable
,Comparable<ChannelState>
,Constable
The possible states an ANT channel can be in.
- Since:
- 4.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionReady to be configured and then opened.Received state does not match possible states.Open and searching for devices with matching channel IDFound and connected to a device.Not configured and closed. -
Method Summary
Modifier and TypeMethodDescriptionstatic ChannelState
create
(int rawValue) Creates the channel state from a raw value.int
Returns the raw value for this channel state.static ChannelState
Returns the enum constant of this class with the specified name.static ChannelState[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNASSIGNED
Not configured and closed.- Since:
- 4.0
-
ASSIGNED
Ready to be configured and then opened.- Since:
- 4.0
-
SEARCHING
Open and searching for devices with matching channel ID- Since:
- 4.0
-
TRACKING
Found and connected to a device.- Since:
- 4.0
-
INVALID
Received state does not match possible states.- Since:
- 4.0
-
-
Method Details
-
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
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 nameNullPointerException
- 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
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
-