com.saperion.jcs.modules.users.api

Enum Tenant.DefaultTenantFields

java.lang.Object

java.lang.Enum<Tenant.DefaultTenantFields>

com.saperion.jcs.modules.users.api.Tenant.DefaultTenantFields

All Implemented Interfaces:

Serializable, Comparable<Tenant.DefaultTenantFields>

Enclosing interface:

Tenant

public static enum Tenant.DefaultTenantFields
extends Enum<Tenant.DefaultTenantFields>

Fields contained in the default database definition of a group.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCRIPTION
ID
NAME

Method Summary

Methods

Modifier and Type	Method and Description
static Tenant.DefaultTenantFields	fromString(String string) Returns the enum constant that matches the specified string regardless if it is uper-case or not.
static boolean	isContained(String name) Checks if a field with the specified name exists in the default database definition of a group.
Class<?>	type()
static Tenant.DefaultTenantFields	valueOf(String name) Returns the enum constant of this type with the specified name.
static Tenant.DefaultTenantFields[]	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

ID

public static final Tenant.DefaultTenantFields ID

NAME

public static final Tenant.DefaultTenantFields NAME

DESCRIPTION

public static final Tenant.DefaultTenantFields DESCRIPTION

Method Detail

values

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

Returns:

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

valueOf

public static Tenant.DefaultTenantFields 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

type

public Class<?> type()

Returns:

the type of the field

isContained

public static boolean isContained(String name)

Checks if a field with the specified name exists in the default database definition of a group.

Parameters:

name - the name. Will be converted to upper-case when checking existence.

Returns:

true if a field with the specified name exists

fromString

public static Tenant.DefaultTenantFields fromString(String string)
                                             throws IllegalArgumentException

Returns the enum constant that matches the specified string regardless if it is uper-case or not.

Parameters:

string - string to find constant for

Returns:

one of Tenant.DefaultTenantFields

Throws:

IllegalArgumentException - if no matching constant was found