Package com.terracottatech.store.configuration

Enum Class PersistentStorageEngine

java.lang.Object

java.lang.Enum<PersistentStorageEngine>

com.terracottatech.store.configuration.PersistentStorageEngine

All Implemented Interfaces:

PersistentStorageType, Serializable, Comparable<PersistentStorageEngine>, Constable

public enum PersistentStorageEngine
extends Enum<PersistentStorageEngine>
implements PersistentStorageType

Programmatic representation of various persistent storage engine supported by the system and their attributes.

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
FRS
HYBRID

Field Summary

Fields inherited from interface com.terracottatech.store.configuration.PersistentStorageType

FRS_PERMANENT_ID, HYBRID_PERMANENT_ID

Method Summary

Modifier and Type	Method	Description
ProductFeatureStatus	getEngineStatus()	Returns the status of the current feature support for this particular persistent storage engine.
String	getLongName()	Returns a display name for this persistent storage type that cen be used for logging etc.
int	getPermanentId()	Returns a permanent identifier for this persistent storage type that is guaranteed to stay unique, regardless of all the new persistent storage type(s) that may be added in the future.
String	getShortName()	Returns a case insensitive name for this persistent storage type that can be used for configuration etc.
static PersistentStorageEngine	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PersistentStorageEngine[]	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

FRS

public static final PersistentStorageEngine FRS

HYBRID

public static final PersistentStorageEngine HYBRID

Method Details

values

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

getLongName

public String getLongName()

Description copied from interface: PersistentStorageType

Returns a display name for this persistent storage type that cen be used for logging etc.

Specified by:

getLongName in interface PersistentStorageType

Returns:

a display name

getShortName

public String getShortName()

Description copied from interface: PersistentStorageType

Returns a case insensitive name for this persistent storage type that can be used for configuration etc.

Specified by:

getShortName in interface PersistentStorageType

Returns:

a short name that can be used to match with config, if any

getEngineStatus

public ProductFeatureStatus getEngineStatus()

Description copied from interface: PersistentStorageType

Returns the status of the current feature support for this particular persistent storage engine.

Specified by:

getEngineStatus in interface PersistentStorageType

Returns:

status of this product feature

getPermanentId

public int getPermanentId()

Description copied from interface: PersistentStorageType

Returns a permanent identifier for this persistent storage type that is guaranteed to stay unique, regardless of all the new persistent storage type(s) that may be added in the future.

Specified by:

getPermanentId in interface PersistentStorageType

Returns:

a permanent identifier for this persistent storage type