org.hibernate.cache.spi.access

Enum AccessType

java.lang.Object

java.lang.Enum<AccessType>

org.hibernate.cache.spi.access.AccessType

All Implemented Interfaces:

Serializable, Comparable<AccessType>

public enum AccessType
extends Enum<AccessType>

The types of access strategies available.

Author:

Steve Ebersole

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONSTRICT_READ_WRITE Read and write access (non-strict).
READ_ONLY Read-only access.
READ_WRITE Read and write access (strict).
TRANSACTIONAL A read and write strategy where isolation/locking is maintained in conjunction with a JTA transaction.

Method Summary

Modifier and Type	Method and Description
static AccessType	fromExternalName(String externalName) Resolve an AccessType from its external name.
String	getExternalName() Get the corresponding externalized name for this value.
String	toString()
static AccessType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READ_ONLY

public static final AccessType READ_ONLY

Read-only access. Data may be added and removed, but not mutated.

READ_WRITE

public static final AccessType READ_WRITE

Read and write access (strict). Data may be added, removed and mutated.

NONSTRICT_READ_WRITE

public static final AccessType NONSTRICT_READ_WRITE

Read and write access (non-strict). Data may be added, removed and mutated. The non-strictness comes from the fact that locks are not maintained as tightly as in READ_WRITE, which leads to better throughput but may also lead to inconsistencies.

TRANSACTIONAL

public static final AccessType TRANSACTIONAL

A read and write strategy where isolation/locking is maintained in conjunction with a JTA transaction.

Method Detail

values

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

Returns:

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

valueOf

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

getExternalName

public String getExternalName()

Get the corresponding externalized name for this value.

Returns:

The corresponding externalized name.

toString

public String toString()

Overrides:

toString in class Enum<AccessType>

fromExternalName

public static AccessType fromExternalName(String externalName)

Resolve an AccessType from its external name.

Parameters:

externalName - The external representation to resolve

Returns:

The access type.

Throws:

UnknownAccessTypeException - If the externalName was not recognized.

See Also:

getExternalName()