Package africa.absa.inception.security

Enum Class PasswordChangeReason

java.lang.Object

java.lang.Enum<PasswordChangeReason>

africa.absa.inception.security.PasswordChangeReason

All Implemented Interfaces:

Serializable, Comparable<PasswordChangeReason>, Constable

public enum PasswordChangeReason
extends Enum<PasswordChangeReason>

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

Author:

Marcus Portmann

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINISTRATIVE	Administrative.
RESET	Reset.
USER	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 class with the specified name.
static PasswordChangeReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER

public static final PasswordChangeReason USER

User.

ADMINISTRATIVE

public static final PasswordChangeReason ADMINISTRATIVE

Administrative.

RESET

public static final PasswordChangeReason RESET

Reset.

Method Details

values

public static PasswordChangeReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PasswordChangeReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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