com.digi.xbee.api.models

Enum SrpStep

java.lang.Object

java.lang.Enum<SrpStep>

com.digi.xbee.api.models.SrpStep

All Implemented Interfaces:

Serializable, Comparable<SrpStep>

public enum SrpStep
extends Enum<SrpStep>

Enumerates the available steps of the SRP authentication.

Since:

1.3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
STEP_1
STEP_2
STEP_3
STEP_4
UNKNOWN

Method Summary

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

STEP_1

public static final SrpStep STEP_1

STEP_2

public static final SrpStep STEP_2

STEP_3

public static final SrpStep STEP_3

STEP_4

public static final SrpStep STEP_4

UNKNOWN

public static final SrpStep UNKNOWN

Method Detail

get

public static SrpStep get(int id)

Retrieves the SrpStep for the given ID code.

Parameters:

id - ID code to retrieve the SrpStep.

Returns:

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

getDescription

public String getDescription()

Retrieves the SrpStep description.

Returns:

SrpStep description.

getID

public int getID()

Retrieves the SrpStep ID code.

Returns:

SrpStep ID code.

valueOf

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

Returns:

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