com.dsi.ant.message

Enum ResponseCode

java.lang.Object

java.lang.Enum<ResponseCode>

com.dsi.ant.message.ResponseCode

All Implemented Interfaces:

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

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

The possible response codes a ChannelResponseMessage can contain.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_ID_NOT_SET returned on attempt to open a channel without setting the channel ID
CHANNEL_IN_WRONG_STATE returned on attempt to perform an action from the wrong channel state
CHANNEL_NOT_OPENED returned on attempt to communicate on a channel that is not open
INVALID_LIST_ID returned when the provided list ID or size exceeds the limit
INVALID_MESSAGE returned when the message has an invalid parameter
INVALID_PARAMETER_PROVIDED returned when an invalid parameter is specified in a configuration message
MESSAGE_SIZE_EXCEEDS_LIMIT returned if a data message is provided that is too large
RESPONSE_NO_ERROR Returned to indicate success.
UNKNOWN The value sent from the ANT Radio Service is not defined in this version of the API

Method Summary

Methods

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

RESPONSE_NO_ERROR

public static final ResponseCode RESPONSE_NO_ERROR

Returned to indicate success.

Since:

4.0

CHANNEL_IN_WRONG_STATE

public static final ResponseCode CHANNEL_IN_WRONG_STATE

returned on attempt to perform an action from the wrong channel state

Since:

4.0

CHANNEL_NOT_OPENED

public static final ResponseCode CHANNEL_NOT_OPENED

returned on attempt to communicate on a channel that is not open

Since:

4.0

CHANNEL_ID_NOT_SET

public static final ResponseCode CHANNEL_ID_NOT_SET

returned on attempt to open a channel without setting the channel ID

Since:

4.0

MESSAGE_SIZE_EXCEEDS_LIMIT

public static final ResponseCode MESSAGE_SIZE_EXCEEDS_LIMIT

returned if a data message is provided that is too large

Since:

4.0

INVALID_MESSAGE

public static final ResponseCode INVALID_MESSAGE

returned when the message has an invalid parameter

Since:

4.0

INVALID_LIST_ID

public static final ResponseCode INVALID_LIST_ID

returned when the provided list ID or size exceeds the limit

Since:

4.0

INVALID_PARAMETER_PROVIDED

public static final ResponseCode INVALID_PARAMETER_PROVIDED

returned when an invalid parameter is specified in a configuration message

Since:

4.0

UNKNOWN

public static final ResponseCode UNKNOWN

The value sent from the ANT Radio Service is not defined in this version of the API

Since:

4.0

Method Detail

values

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

Returns:

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

valueOf

public static ResponseCode 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()

Gets the raw value of this ResponseCode. Applications should use the enumeration values directly.

Returns:

The raw value.

Since:

4.0

create

public static ResponseCode create(int rawValue)

Creates the ResponseCode from the raw value. Applications should access the enumeration values directly.

Parameters:

rawValue - The raw value.

Returns:

The response code.

Since:

4.0