com.apple.foundationdb.record.provider.common

Enum RecordSerializer.Counts

java.lang.Object

java.lang.Enum<RecordSerializer.Counts>

com.apple.foundationdb.record.provider.common.RecordSerializer.Counts

All Implemented Interfaces:

StoreTimer.Count, StoreTimer.Event, Serializable, Comparable<RecordSerializer.Counts>

Enclosing interface:

RecordSerializer<M extends Message>

@API(value=UNSTABLE)
public static enum RecordSerializer.Counts
extends Enum<RecordSerializer.Counts>
implements StoreTimer.Count

Instrumentation counts related to record serialization.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESCHEW_RECORD_COMPRESSION The number of times that record compression was not effective and the record was kept uncompressed.

Method Summary

Modifier and Type	Method and Description
boolean	isSize() Get whether the count value is actually a size in bytes.
String	logKey() Get the key of this event for logging.
String	title() Get the title of this event for user displays.
static RecordSerializer.Counts	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordSerializer.Counts[]	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

ESCHEW_RECORD_COMPRESSION

public static final RecordSerializer.Counts ESCHEW_RECORD_COMPRESSION

The number of times that record compression was not effective and the record was kept uncompressed.

Method Detail

values

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

Returns:

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

valueOf

public static RecordSerializer.Counts 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

isSize

public boolean isSize()

Description copied from interface: StoreTimer.Count

Get whether the count value is actually a size in bytes.

Specified by:

isSize in interface StoreTimer.Count

Returns:

true if the count value is actually a size in bytes