Package africa.absa.inception.security

Enum Class TenantStatus

java.lang.Object

java.lang.Enum<TenantStatus>

africa.absa.inception.security.TenantStatus

All Implemented Interfaces:

Serializable, Comparable<TenantStatus>, Constable

public enum TenantStatus
extends Enum<TenantStatus>

The TenantStatus enumeration defines the possible statuses for a tenant.

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.
INACTIVE	Inactive.

Method Summary

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

Inactive.

ACTIVE

public static final TenantStatus ACTIVE

Active.

Method Details

values

public static TenantStatus[] 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 TenantStatus 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 TenantStatus fromCode(String code)

Returns the tenant status given by the specified code value.

Parameters:

code - the code for the tenant status

Returns:

the tenant status given by the specified code value

toNumericCode

public static int toNumericCode(TenantStatus tenantStatus)

Returns the numeric code for the tenant status.

Parameters:

tenantStatus - the tenant status

Returns:

the numeric code for the tenant status

fromNumericCode

public static TenantStatus fromNumericCode(int numericCode)

Returns the tenant status for the specified numeric code.

Parameters:

numericCode - the numeric code for the tenant status

Returns:

the tenant status given by the specified numeric code value

code

public String code()

Returns the code value for the tenant status.

Returns:

the code value for the tenant status

description

public String description()

Returns the description for the tenant status.

Returns:

the description for the tenant status