Package org.infinispan.configuration.cache

Enum Class StorageType

java.lang.Object

java.lang.Enum<StorageType>

org.infinispan.configuration.cache.StorageType

All Implemented Interfaces:

Serializable, Comparable<StorageType>, Constable

public enum StorageType
extends Enum<StorageType>

Enumeration defining the various storage types for the data container.

Since:

9.0

Author:

wburns

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
BINARY	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0, with no replacement.
HEAP	Objects are stored on heap.
OBJECT	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0, use HEAP instead.
OFF_HEAP	Entries are stored in internal memory off the normal Java heap.

Method Summary

Modifier and Type	Method	Description
boolean	canStoreReferences()
static StorageType	forElement(String element)
Element	getElement()
static StorageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StorageType[]	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

OBJECT

@Deprecated(forRemoval=true,
            since="11.0")
public static final StorageType OBJECT

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0, use HEAP instead.

Objects are stored on heap as objects as provided. These are serialized across to other nodes and stored as deserialized instances of the object. Equality is defined by the equals method of the implementation class.

HEAP

public static final StorageType HEAP

Objects are stored on heap. Equality is defined by the equals of the implementation class. If the configured MediaType causes the storage to be byte[], then equality is defined by these byte[] instances.

BINARY

@Deprecated(forRemoval=true,
            since="11.0")
public static final StorageType BINARY

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0, with no replacement. Use HEAP and the cache's EncodingConfiguration to define a MediaType that is byte[] or primitive based.

Entries are stored in Java heap but as byte[] instances. This mode has equality defined by the byte[] created from the serialized from of the provided object.

OFF_HEAP

public static final StorageType OFF_HEAP

Entries are stored in internal memory off the normal Java heap. This mode has equality defined by the byte[] created from the serialized form of the provided object.

Method Details

values

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

getElement

public Element getElement()

forElement

public static StorageType forElement(String element)

canStoreReferences

public boolean canStoreReferences()