com.apple.foundationdb.record.provider.foundationdb.indexes

Enum RankedSetIndexHelper.Events

java.lang.Object

java.lang.Enum<RankedSetIndexHelper.Events>

com.apple.foundationdb.record.provider.foundationdb.indexes.RankedSetIndexHelper.Events

All Implemented Interfaces:

StoreTimer.DetailEvent, StoreTimer.Event, Serializable, Comparable<RankedSetIndexHelper.Events>

Enclosing class:

RankedSetIndexHelper

public static enum RankedSetIndexHelper.Events
extends Enum<RankedSetIndexHelper.Events>
implements StoreTimer.DetailEvent

Instrumentation events specific to rank index maintenance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RANKED_SET_RANK_FOR_SCORE
RANKED_SET_SCORE_FOR_RANK
RANKED_SET_UPDATE

Method Summary

Modifier and Type	Method and Description
String	logKey() Get the key of this event for logging.
String	title() Get the title of this event for user displays.
static RankedSetIndexHelper.Events	valueOf(String name) Returns the enum constant of this type with the specified name.
static RankedSetIndexHelper.Events[]	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

Methods inherited from interface com.apple.foundationdb.record.provider.common.StoreTimer.Event

name

Enum Constant Detail

RANKED_SET_SCORE_FOR_RANK

public static final RankedSetIndexHelper.Events RANKED_SET_SCORE_FOR_RANK

RANKED_SET_RANK_FOR_SCORE

public static final RankedSetIndexHelper.Events RANKED_SET_RANK_FOR_SCORE

RANKED_SET_UPDATE

public static final RankedSetIndexHelper.Events RANKED_SET_UPDATE

Method Detail

values

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

Returns:

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

valueOf

public static RankedSetIndexHelper.Events 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

title

public String title()

Description copied from interface: StoreTimer.Event

Get the title of this event for user displays.

Specified by:

title in interface StoreTimer.Event

Returns:

the user-visible title

logKey

@Nonnull
public String logKey()

Description copied from interface: StoreTimer.Event

Get the key of this event for logging. This should be used with KeyValueLogMessages and other key-value based logging systems to log the values from instrumented events. These keys are not expected to change frequently. They may, however, change outside of any minor version change. Their values, therefore, should not be relied upon, other than for the logging purposes.

Specified by:

logKey in interface StoreTimer.Event

Returns:

the key to use for logging