Package africa.absa.inception.security

Enum UserStatus

java.lang.Object

java.lang.Enum<UserStatus>

africa.absa.inception.security.UserStatus

All Implemented Interfaces:

Serializable, Comparable<UserStatus>

public enum UserStatus
extends Enum<UserStatus>

The UserStatus enumeration defines the possible statuses for a user.

Author:

Marcus Portmann

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE
EXPIRED
INACTIVE
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 type with the specified name.
static UserStatus[]	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

INACTIVE

public static final UserStatus INACTIVE

ACTIVE

public static final UserStatus ACTIVE

LOCKED

public static final UserStatus LOCKED

EXPIRED

public static final UserStatus EXPIRED

Method Detail

values

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

Returns:

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

valueOf

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

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