Package com.hazelcast.config

Enum Class MetadataPolicy

java.lang.Object

java.lang.Enum<MetadataPolicy>

com.hazelcast.config.MetadataPolicy

All Implemented Interfaces:

Serializable, Comparable<MetadataPolicy>, Constable

public enum MetadataPolicy
extends Enum<MetadataPolicy>

Hazelcast may process objects of supported types ahead of time to create additional metadata about them. This metadata then is used to make querying and indexing faster.

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
CREATE_ON_UPDATE	Hazelcast processes supported objects at the time of creation and updates.
OFF	Turns off metadata creation.

Method Summary

Modifier and Type	Method	Description
static MetadataPolicy	getById(int id)	Returns the MetadataPolicy for the given ID.
int	getId()	Returns enumeration id of this policy.
static MetadataPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetadataPolicy[]	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

CREATE_ON_UPDATE

public static final MetadataPolicy CREATE_ON_UPDATE

Hazelcast processes supported objects at the time of creation and updates. This may increase put latency for the specific data structure that this option is configured with.

OFF

public static final MetadataPolicy OFF

Turns off metadata creation.

Method Details

values

public static MetadataPolicy[] 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 MetadataPolicy 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

getId

public int getId()

Returns enumeration id of this policy. We use id field instead of Enum.ordinal() because this value is used in client protocol. The ids for the known policies must not be changed.

Returns:

id

getById

public static MetadataPolicy getById(int id)

Returns the MetadataPolicy for the given ID.

Returns:

the MetadataPolicy found or null if not found