Package org.opends.server.backends.pluggable.spi

Enum Class Storage.ReadHint

java.lang.Object

java.lang.Enum<Storage.ReadHint>

org.opends.server.backends.pluggable.spi.Storage.ReadHint

All Implemented Interfaces:

Serializable, Comparable<Storage.ReadHint>, java.lang.constant.Constable

Enclosing interface:

Storage

public static enum Storage.ReadHint
extends Enum<Storage.ReadHint>

Options applicable to read transactions and operations.

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
NO_CACHE	Hint that the operation should not perturb the Storage's cache, for example, when scanning over all records in a database.
READ_UNCOMMITTED	Hint that the caller can tolerate reads of uncommitted (or dirty) data.
USER_TRANSACTION	Hint that the transaction is directly associated with a user request and may be throttled if desired in order to prevent excessive resource contention when subjected to a large number of concurrent user requests.

Method Summary

Modifier and Type	Method	Description
static Storage.ReadHint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Storage.ReadHint[]	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

NO_CACHE

public static final Storage.ReadHint NO_CACHE

Hint that the operation should not perturb the Storage's cache, for example, when scanning over all records in a database.

READ_UNCOMMITTED

public static final Storage.ReadHint READ_UNCOMMITTED

Hint that the caller can tolerate reads of uncommitted (or dirty) data. Only use this hint when you really do not care about data being stable.

USER_TRANSACTION

public static final Storage.ReadHint USER_TRANSACTION

Hint that the transaction is directly associated with a user request and may be throttled if desired in order to prevent excessive resource contention when subjected to a large number of concurrent user requests. Specifically, this hint will not be present when performing internal requests, replaying replicated updates or when performing nested (inner) requests, such as those performed when resolving virtual and collective attributes.

Method Details

values

public static Storage.ReadHint[] 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 Storage.ReadHint 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