org.rocksdb

Enum AccessHint

java.lang.Object

java.lang.Enum<AccessHint>

org.rocksdb.AccessHint

All Implemented Interfaces:

Serializable, Comparable<AccessHint>

public enum AccessHint
extends Enum<AccessHint>

File access pattern once a compaction has started

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE
NORMAL
SEQUENTIAL
WILLNEED

Method Summary

Modifier and Type	Method and Description
static AccessHint	getAccessHint(byte byteIdentifier) Get the AccessHint enumeration value by passing the byte identifier to this method.
byte	getValue() Returns the byte value of the enumerations value.
static AccessHint	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessHint[]	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

NONE

public static final AccessHint NONE

NORMAL

public static final AccessHint NORMAL

SEQUENTIAL

public static final AccessHint SEQUENTIAL

WILLNEED

public static final AccessHint WILLNEED

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public byte getValue()

Returns the byte value of the enumerations value.

Returns:

byte representation

getAccessHint

public static AccessHint getAccessHint(byte byteIdentifier)

Get the AccessHint enumeration value by passing the byte identifier to this method.

Parameters:

byteIdentifier - of AccessHint.

Returns:

AccessHint instance.

Throws:

IllegalArgumentException - if the access hint for the byteIdentifier cannot be found