org.rocksdb

Enum MemoryUsageType

java.lang.Object

java.lang.Enum<MemoryUsageType>

org.rocksdb.MemoryUsageType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MemoryUsageType>

public enum MemoryUsageType
extends java.lang.Enum<MemoryUsageType>

MemoryUsageType

The value will be used as a key to indicate the type of memory usage described

Enum Constant Summary

Enum Constants

Enum Constant and Description
kCacheTotal Memory usage by Cache.
kMemTableTotal Memory usage of all the mem-tables.
kMemTableUnFlushed Memory usage of those un-flushed mem-tables.
kNumUsageTypes Max usage types - copied to keep 1:1 with native.
kTableReadersTotal Memory usage of all the table readers.

Method Summary

Methods

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

kMemTableTotal

public static final MemoryUsageType kMemTableTotal

Memory usage of all the mem-tables.

kMemTableUnFlushed

public static final MemoryUsageType kMemTableUnFlushed

Memory usage of those un-flushed mem-tables.

kTableReadersTotal

public static final MemoryUsageType kTableReadersTotal

Memory usage of all the table readers.

kCacheTotal

public static final MemoryUsageType kCacheTotal

Memory usage by Cache.

kNumUsageTypes

public static final MemoryUsageType kNumUsageTypes

Max usage types - copied to keep 1:1 with native.

Method Detail

values

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

Returns:

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

valueOf

public static MemoryUsageType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public byte getValue()

Returns the byte value of the enumerations value

Returns:

byte representation

getMemoryUsageType

public static MemoryUsageType getMemoryUsageType(byte byteIdentifier)

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

Parameters:

byteIdentifier - of MemoryUsageType.

Returns:

MemoryUsageType instance.

Throws:

java.lang.IllegalArgumentException - if the usage type for the byteIdentifier cannot be found