Package org.apache.gravitino.policy

Enum Class Policy.BuiltInType

java.lang.Object

java.lang.Enum<Policy.BuiltInType>

org.apache.gravitino.policy.Policy.BuiltInType

All Implemented Interfaces:

Serializable, Comparable<Policy.BuiltInType>, Constable

Enclosing interface:

Policy

public static enum Policy.BuiltInType
extends Enum<Policy.BuiltInType>

The built-in policy types. Predefined policy types that are provided by the system.

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
CUSTOM	Custom policy type.

Method Summary

Modifier and Type	Method	Description
Class<? extends PolicyContent>	contentClass()	Get the content class of the policy.
static Policy.BuiltInType	fromPolicyType(String policyType)	Get the built-in policy type from the policy type string.
String	policyType()	Get the policy type string.
static Policy.BuiltInType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Policy.BuiltInType[]	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

CUSTOM

public static final Policy.BuiltInType CUSTOM

Custom policy type. "custom" is a fixed string that indicates the policy is a non-built-in type.

Method Details

values

public static Policy.BuiltInType[] 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 Policy.BuiltInType 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

fromPolicyType

public static Policy.BuiltInType fromPolicyType(String policyType)

Get the built-in policy type from the policy type string.

Parameters:

policyType - the policy type string

Returns:

the built-in policy type if it matches, otherwise returns CUSTOM type

policyType

public String policyType()

Get the policy type string.

Returns:

the policy type string

contentClass

public Class<? extends PolicyContent> contentClass()

Get the content class of the policy.

Returns:

the content class of the policy