org.rocksdb

Enum RateLimiterMode

java.lang.Object

java.lang.Enum<RateLimiterMode>

org.rocksdb.RateLimiterMode

All Implemented Interfaces:

Serializable, Comparable<RateLimiterMode>

public enum RateLimiterMode
extends Enum<RateLimiterMode>

Mode for RateLimiter.RateLimiter(long, long, int, RateLimiterMode).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_IO
READS_ONLY
WRITES_ONLY

Method Summary

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

READS_ONLY

public static final RateLimiterMode READS_ONLY

WRITES_ONLY

public static final RateLimiterMode WRITES_ONLY

ALL_IO

public static final RateLimiterMode ALL_IO

Method Detail

values

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

Returns:

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

valueOf

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

getRateLimiterMode

public static RateLimiterMode getRateLimiterMode(byte byteIdentifier)

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

Parameters:

byteIdentifier - of RateLimiterMode.

Returns:

AccessHint instance.

Throws:

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