Package africa.absa.inception.security

Enum Class UserStatus

java.lang.Object

java.lang.Enum<UserStatus>

africa.absa.inception.security.UserStatus

All Implemented Interfaces:

Serializable, Comparable<UserStatus>, Constable

public enum UserStatus
extends Enum<UserStatus>

The UserStatus enumeration defines the possible statuses for a user.

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
ACTIVE	Active.
EXPIRED	Expired.
INACTIVE	Inactive.
LOCKED	Locked.

Method Summary

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

INACTIVE

public static final UserStatus INACTIVE

Inactive.

ACTIVE

public static final UserStatus ACTIVE

Active.

LOCKED

public static final UserStatus LOCKED

Locked.

EXPIRED

public static final UserStatus EXPIRED

Expired.

Method Details

values

public static UserStatus[] 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 UserStatus 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

toNumericCode

public static int toNumericCode(UserStatus userStatus)

Returns the numeric code for the user status.

Parameters:

userStatus - the user status

Returns:

the numeric code for the user status

fromNumericCode

public static UserStatus fromNumericCode(int numericCode)

Returns the user status for the specified numeric code.

Parameters:

numericCode - the numeric code for the user status

Returns:

the user status given by the specified numeric code value

fromCode

public static UserStatus fromCode(String code)

Returns the user status given by the specified code value.

Parameters:

code - the code for the user status

Returns:

the user status given by the specified code value

code

public String code()

Returns the code value for the user status.

Returns:

the code value for the user status

description

public String description()

Returns the description for the user status.

Returns:

the description for the user status