com.digi.xbee.api.models

Enum OperatingMode

java.lang.Object

java.lang.Enum<OperatingMode>

com.digi.xbee.api.models.OperatingMode

All Implemented Interfaces:

Serializable, Comparable<OperatingMode>

public enum OperatingMode
extends Enum<OperatingMode>

Enumerates the different working modes of the XBee device. The operating mode establishes the way a user communicates with an XBee device through its serial interface.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API
API_ESCAPE
AT
UNKNOWN

Method Summary

Modifier and Type	Method and Description
int	getID() Returns the operating mode ID.
String	getName() Returns the operating mode name.
String	toString()
static OperatingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OperatingMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

API

public static final OperatingMode API

API_ESCAPE

public static final OperatingMode API_ESCAPE

AT

public static final OperatingMode AT

UNKNOWN

public static final OperatingMode UNKNOWN

Method Detail

getID

public int getID()

Returns the operating mode ID.

Returns:

Operating mode ID.

getName

public String getName()

Returns the operating mode name.

Returns:

Operating mode name.

toString

public String toString()

Overrides:

toString in class Enum<OperatingMode>

valueOf

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

Returns:

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