com.apple.foundationdb.record.provider.foundationdb

Enum FDBLatencySource

java.lang.Object

java.lang.Enum<FDBLatencySource>

com.apple.foundationdb.record.provider.foundationdb.FDBLatencySource

All Implemented Interfaces:

Serializable, Comparable<FDBLatencySource>

public enum FDBLatencySource
extends Enum<FDBLatencySource>

Indicates which FDB API calls are to have latency injected into them via FDBDatabaseFactory.setLatencyInjector(Function).

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMIT_ASYNC See FDBRecordContext.commitAsync().
GET_READ_VERSION See FDBRecordContext.getReadVersion().

Method Summary

Modifier and Type	Method and Description
StoreTimer.Event	getTimerEvent() Get the event used to track this latency source by FDBStoreTimers.
static FDBLatencySource	valueOf(String name) Returns the enum constant of this type with the specified name.
static FDBLatencySource[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GET_READ_VERSION

public static final FDBLatencySource GET_READ_VERSION

See FDBRecordContext.getReadVersion().

COMMIT_ASYNC

public static final FDBLatencySource COMMIT_ASYNC

See FDBRecordContext.commitAsync().

Method Detail

values

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

Returns:

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

valueOf

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

getTimerEvent

@Nonnull
public StoreTimer.Event getTimerEvent()

Get the event used to track this latency source by FDBStoreTimers.

Returns:

the event used to instrument injecting this latency source