com.digi.xbee.api.models

Enum SendDataRequestOptions

java.lang.Object

java.lang.Enum<SendDataRequestOptions>

com.digi.xbee.api.models.SendDataRequestOptions

All Implemented Interfaces:

Serializable, Comparable<SendDataRequestOptions>

public enum SendDataRequestOptions
extends Enum<SendDataRequestOptions>

Enumerates the different options for the SendDataRequestPacket.

Since:

1.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND
ARCHIVE
OVERWRITE
TRANSIENT

Method Summary

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

APPEND

public static final SendDataRequestOptions APPEND

ARCHIVE

public static final SendDataRequestOptions ARCHIVE

OVERWRITE

public static final SendDataRequestOptions OVERWRITE

TRANSIENT

public static final SendDataRequestOptions TRANSIENT

Method Detail

get

public static SendDataRequestOptions get(int id)

Retrieves the SendDataRequestOptions for the given ID.

Parameters:

id - ID to retrieve.

Returns:

The SendDataRequestOptions associated to the given ID.

getID

public int getID()

Retrieves the option ID.

Returns:

The option ID.

getName

public String getName()

Retrieves the option name.

Returns:

The option name.

toString

public String toString()

Overrides:

toString in class Enum<SendDataRequestOptions>

valueOf

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

Returns:

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