Package africa.absa.inception.security

Enum PasswordChangeReason

java.lang.Object

java.lang.Enum<PasswordChangeReason>

africa.absa.inception.security.PasswordChangeReason

All Implemented Interfaces:

Serializable, Comparable<PasswordChangeReason>

public enum PasswordChangeReason
extends Enum<PasswordChangeReason>

The PasswordChangeReason enumeration defines the possible reasons for why a user's password was changed.

Author:

Marcus Portmann

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINISTRATIVE
RESET
USER

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the code for the password change reason.
String	description()	Returns the description for the password change reason.
static PasswordChangeReason	fromCode(String code)	Returns the password change reason given by the specified code value.
static PasswordChangeReason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PasswordChangeReason[]	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

USER

public static final PasswordChangeReason USER

ADMINISTRATIVE

public static final PasswordChangeReason ADMINISTRATIVE

RESET

public static final PasswordChangeReason RESET

Method Detail

values

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

Returns:

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

valueOf

public static PasswordChangeReason 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 PasswordChangeReason fromCode(String code)

Returns the password change reason given by the specified code value.

Parameters:

code - the code for the password change reason

Returns:

the password change reason given by the specified code value

code

public String code()

Returns the code for the password change reason.

Returns:

the code for the password change reason

description

public String description()

Returns the description for the password change reason.

Returns:

the description for the password change reason