com.digi.xbee.api.models

Enum XBeeLocalInterface

java.lang.Object

java.lang.Enum<XBeeLocalInterface>

com.digi.xbee.api.models.XBeeLocalInterface

All Implemented Interfaces:

Serializable, Comparable<XBeeLocalInterface>

public enum XBeeLocalInterface
extends Enum<XBeeLocalInterface>

Enumerates the different XBee local interfaces used in the Relay API packets.

Since:

1.3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLUETOOTH
MICROPYTHON
SERIAL
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static XBeeLocalInterface	get(int id) Retrieves the XBeeLocalInterface for the given ID code.
String	getDescription() Retrieves the XBeeLocalInterface description.
int	getID() Retrieves the XBeeLocalInterface ID code.
static XBeeLocalInterface	valueOf(String name) Returns the enum constant of this type with the specified name.
static XBeeLocalInterface[]	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

BLUETOOTH

public static final XBeeLocalInterface BLUETOOTH

MICROPYTHON

public static final XBeeLocalInterface MICROPYTHON

SERIAL

public static final XBeeLocalInterface SERIAL

UNKNOWN

public static final XBeeLocalInterface UNKNOWN

Method Detail

get

public static XBeeLocalInterface get(int id)

Retrieves the XBeeLocalInterface for the given ID code.

Parameters:

id - ID code to retrieve the XBeeLocalInterface.

Returns:

The XBeeLocalInterface associated with the given ID code, UNKNOWN if there is not any XBee local interface associated to the provided ID.

getDescription

public String getDescription()

Retrieves the XBeeLocalInterface description.

Returns:

XBeeLocalInterface description.

getID

public int getID()

Retrieves the XBeeLocalInterface ID code.

Returns:

XBeeLocalInterface ID code.

valueOf

public static XBeeLocalInterface valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

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

Returns:

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