Package com.datumbox.framework.common.storage.interfaces

Enum StorageEngine.StorageHint

java.lang.Object

java.lang.Enum<StorageEngine.StorageHint>

com.datumbox.framework.common.storage.interfaces.StorageEngine.StorageHint

All Implemented Interfaces:

Serializable, Comparable<StorageEngine.StorageHint>

Enclosing interface:

StorageEngine

public static enum StorageEngine.StorageHint
extends Enum<StorageEngine.StorageHint>

A hint on where to ideally store the map. There are no guarantees over how the StorageEngine will actually store the data, but some engines will use this info to keep as many important data in memory as possible.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IN_CACHE	This option will hint the storage engine that you wish to keep part of the map in the cache and the rest in the disk.
IN_DISK	This option will hint the storage engine that you wish to keep the map in disk.
IN_MEMORY	This option will hint the storage engine that you wish to keep the map in memory.

Method Summary

Modifier and Type	Method	Description
static StorageEngine.StorageHint	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StorageEngine.StorageHint[]	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

IN_MEMORY

public static final StorageEngine.StorageHint IN_MEMORY

This option will hint the storage engine that you wish to keep the map in memory.

IN_CACHE

public static final StorageEngine.StorageHint IN_CACHE

This option will hint the storage engine that you wish to keep part of the map in the cache and the rest in the disk.

IN_DISK

public static final StorageEngine.StorageHint IN_DISK

This option will hint the storage engine that you wish to keep the map in disk.

Method Detail

values

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

Returns:

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

valueOf

public static StorageEngine.StorageHint 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