com.digi.xbee.api.models

Enum SrpError

java.lang.Object

java.lang.Enum<SrpError>

com.digi.xbee.api.models.SrpError

All Implemented Interfaces:

Serializable, Comparable<SrpError>

public enum SrpError
extends Enum<SrpError>

Enumerates the different errors of the SRP authentication.

Since:

1.3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_PROOF_KEY
INCORRECT_PAYLOAD_LENGTH
NOT_CORRECT_SEQUENCE
RESOURCE_ALLOCATION_ERROR
UNABLE_OFFER_B
UNKNOWN

Method Summary

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

BAD_PROOF_KEY

public static final SrpError BAD_PROOF_KEY

INCORRECT_PAYLOAD_LENGTH

public static final SrpError INCORRECT_PAYLOAD_LENGTH

NOT_CORRECT_SEQUENCE

public static final SrpError NOT_CORRECT_SEQUENCE

RESOURCE_ALLOCATION_ERROR

public static final SrpError RESOURCE_ALLOCATION_ERROR

UNABLE_OFFER_B

public static final SrpError UNABLE_OFFER_B

UNKNOWN

public static final SrpError UNKNOWN

Method Detail

get

public static SrpError get(int id)

Retrieves the SrpError for the given ID code.

Parameters:

id - ID code to retrieve the SrpError.

Returns:

The SrpError associated with the given ID code, UNKNOWN if there is not any SRP error associated to the provided ID.

getDescription

public String getDescription()

Retrieves the SrpError description.

Returns:

SrpError description.

getID

public int getID()

Retrieves the SrpError ID code.

Returns:

SrpError ID code.

valueOf

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

Returns:

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