Package org.cyclos.model.users.phones

Enum CodeVerificationStatus

java.lang.Object

java.lang.Enum<CodeVerificationStatus>

org.cyclos.model.users.phones.CodeVerificationStatus

All Implemented Interfaces:

Serializable, Comparable<CodeVerificationStatus>

public enum CodeVerificationStatus
extends Enum<CodeVerificationStatus>

Possible status for the verification of a code entered by a user.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CODE_NOT_SEND	There isn't a current code to be verified (for example the was never sent or the code was reset by max attempts reached)
EXPIRED	The code has expired and can't be used anymore.
FAILED	The code was wrong (it doesn't match the expected value)
MAX_ATTEMPTS_REACHED	The max attempts with an invalid code was reached.
SUCCESS	The code was correct and accepted.

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()
static CodeVerificationStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CodeVerificationStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final CodeVerificationStatus SUCCESS

The code was correct and accepted.

FAILED

public static final CodeVerificationStatus FAILED

The code was wrong (it doesn't match the expected value)

CODE_NOT_SEND

public static final CodeVerificationStatus CODE_NOT_SEND

There isn't a current code to be verified (for example the was never sent or the code was reset by max attempts reached)

EXPIRED

public static final CodeVerificationStatus EXPIRED

The code has expired and can't be used anymore.

MAX_ATTEMPTS_REACHED

public static final CodeVerificationStatus MAX_ATTEMPTS_REACHED

The max attempts with an invalid code was reached.

Method Detail

values

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

Returns:

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

valueOf

public static CodeVerificationStatus 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

isSuccess

public boolean isSuccess()