org.apache.curator.framework.recipes.cache

Enum CuratorCache.Options

java.lang.Object

java.lang.Enum<CuratorCache.Options>

org.apache.curator.framework.recipes.cache.CuratorCache.Options

All Implemented Interfaces:

Serializable, Comparable<CuratorCache.Options>

Enclosing interface:

CuratorCache

public static enum CuratorCache.Options
extends Enum<CuratorCache.Options>

cache build options

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESSED_DATA Decompress data via Decompressible.decompressed()
DO_NOT_CLEAR_ON_CLOSE Normally, when the cache is closed via CuratorCache.close(), the storage is cleared via CuratorCacheStorage.clear().
SINGLE_NODE_CACHE Normally the entire tree of nodes starting at the given node are cached.

Method Summary

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

SINGLE_NODE_CACHE

public static final CuratorCache.Options SINGLE_NODE_CACHE

Normally the entire tree of nodes starting at the given node are cached. This option causes only the given node to be cached (i.e. a single node cache)

COMPRESSED_DATA

public static final CuratorCache.Options COMPRESSED_DATA

Decompress data via Decompressible.decompressed()

DO_NOT_CLEAR_ON_CLOSE

public static final CuratorCache.Options DO_NOT_CLEAR_ON_CLOSE

Normally, when the cache is closed via CuratorCache.close(), the storage is cleared via CuratorCacheStorage.clear(). This option prevents the storage from being cleared.

Method Detail

values

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

Returns:

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

valueOf

public static CuratorCache.Options 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