org.craftercms.commons.entitlements.model

Enum EntitlementType

java.lang.Object

java.lang.Enum<EntitlementType>

org.craftercms.commons.entitlements.model.EntitlementType

All Implemented Interfaces:

Serializable, Comparable<EntitlementType>

public enum EntitlementType
extends Enum<EntitlementType>

Holds the available entitlements when requesting an entitlement validation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ITEM
SITE
USER

Method Summary

Modifier and Type	Method and Description
static EntitlementType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EntitlementType[]	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

USER

public static final EntitlementType USER

SITE

public static final EntitlementType SITE

ITEM

public static final EntitlementType ITEM

Method Detail

values

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

Returns:

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

valueOf

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