Package africa.absa.inception.security

Enum PasswordResetStatus

java.lang.Object

java.lang.Enum<PasswordResetStatus>

africa.absa.inception.security.PasswordResetStatus

All Implemented Interfaces:

Serializable, Comparable<PasswordResetStatus>

public enum PasswordResetStatus
extends Enum<PasswordResetStatus>

The PasswordResetStatus enumeration defines the possible statuses for a password reset.

Author:

Marcus Portmann

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETED
EXPIRED
REQUESTED

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the code value for the password reset status.
String	description()	Returns the description for the password reset status.
static PasswordResetStatus	fromCode(String code)	Returns the password reset status given by the specified code value.
static PasswordResetStatus	fromNumericCode(int numericCode)	Returns the password reset status for the specified numeric code.
static int	toNumericCode(PasswordResetStatus passwordResetStatus)	Returns the numeric code for the password reset status.
static PasswordResetStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PasswordResetStatus[]	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

REQUESTED

public static final PasswordResetStatus REQUESTED

COMPLETED

public static final PasswordResetStatus COMPLETED

EXPIRED

public static final PasswordResetStatus EXPIRED

Method Detail

values

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

Returns:

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

valueOf

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

fromCode

public static PasswordResetStatus fromCode(String code)

Returns the password reset status given by the specified code value.

Parameters:

code - the code for the password reset status

Returns:

the password reset status given by the specified code value

toNumericCode

public static int toNumericCode(PasswordResetStatus passwordResetStatus)

Returns the numeric code for the password reset status.

Parameters:

passwordResetStatus - the password reset status

Returns:

the numeric code for the password reset status

fromNumericCode

public static PasswordResetStatus fromNumericCode(int numericCode)

Returns the password reset status for the specified numeric code.

Parameters:

numericCode - the numeric code for the password reset status

Returns:

the password reset status given by the specified numeric code value

code

public String code()

Returns the code value for the password reset status.

Returns:

the code value for the password reset status

description

public String description()

Returns the description for the password reset status.

Returns:

the description for the password reset status