com.digi.xbee.api.models

Enum IPProtocol

java.lang.Object

java.lang.Enum<IPProtocol>

com.digi.xbee.api.models.IPProtocol

All Implemented Interfaces:

Serializable, Comparable<IPProtocol>

public enum IPProtocol
extends Enum<IPProtocol>

Enumerates the different IP protocols.

Since:

1.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
COAP
TCP
TCP_SSL
UDP

Method Summary

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

COAP

public static final IPProtocol COAP

TCP

public static final IPProtocol TCP

TCP_SSL

public static final IPProtocol TCP_SSL

UDP

public static final IPProtocol UDP

Method Detail

get

public static IPProtocol get(int id)

Retrieves the IP protocol for the given ID.

Parameters:

id - ID to retrieve the IP protocol.

Returns:

The IP protocol associated with the given ID.

getID

public int getID()

Retrieves the IP protocol ID.

Returns:

IP protocol ID.

getName

public String getName()

Retrieves the IP protocol name.

Returns:

IP protocol name.

toString

public String toString()

Overrides:

toString in class Enum<IPProtocol>

valueOf

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

Returns:

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