com.dsi.ant

Enum AntService.Component

java.lang.Object

java.lang.Enum<AntService.Component>

com.dsi.ant.AntService.Component

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AntService.Component>

Enclosing class:

AntService

public static enum AntService.Component
extends java.lang.Enum<AntService.Component>

Used internally by the API. All the possible components that AntService can retrieve from the ANT Radio Service.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADAPTER_PROVIDER Responsible for providing hardware information to applications.
CHANNEL_PROVIDER Responsible for providing ANT channels to applications.
INVALID The Component if the received component from ANT Radio Service is not supported in this version of the API.

Method Summary

Methods

Modifier and Type	Method and Description
static AntService.Component	create(int rawValue) Used internally by the API to create a Component from a raw value received from ANT Radio Service.
int	getRawValue() Returns the raw value of this Component.
static AntService.Component	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AntService.Component[]	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

INVALID

public static final AntService.Component INVALID

The Component if the received component from ANT Radio Service is not supported in this version of the API.

Since:

4.0

CHANNEL_PROVIDER

public static final AntService.Component CHANNEL_PROVIDER

Responsible for providing ANT channels to applications.

Since:

4.0

ADAPTER_PROVIDER

public static final AntService.Component ADAPTER_PROVIDER

Responsible for providing hardware information to applications.

Since:

4.7.2

Method Detail

values

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

Returns:

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

valueOf

public static AntService.Component 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 of this Component. Used internally by the API to specify which component to retrieve.

Since:

4.0

create

public static AntService.Component create(int rawValue)

Used internally by the API to create a Component from a raw value received from ANT Radio Service. Applications must use the methods provided in AntService such as AntService.getChannelProvider() to retrieve components.

Since:

4.0