com.netflix.curator.framework.recipes.cache
Enum PathChildrenCacheMode

java.lang.Object
  java.lang.Enum<PathChildrenCacheMode>
      com.netflix.curator.framework.recipes.cache.PathChildrenCacheMode

All Implemented Interfaces:

Serializable, Comparable<PathChildrenCacheMode>

public enum PathChildrenCacheMode
extends Enum<PathChildrenCacheMode>

Controls which data is cached

Enum Constant Summary

CACHE_DATA
The cache will hold all the children and the data for each child node.

CACHE_DATA_AND_STAT
The cache will hold all the children, the data for each child node and the stat for each child node

CACHE_PATHS_ONLY
The cache will hold only the children path names.

Method Summary

static PathChildrenCacheMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathChildrenCacheMode[]	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

CACHE_DATA_AND_STAT

public static final PathChildrenCacheMode CACHE_DATA_AND_STAT

The cache will hold all the children, the data for each child node and the stat for each child node

CACHE_DATA

public static final PathChildrenCacheMode CACHE_DATA

The cache will hold all the children and the data for each child node. ChildData.getStat() will return null.

CACHE_PATHS_ONLY

public static final PathChildrenCacheMode CACHE_PATHS_ONLY

The cache will hold only the children path names. ChildData.getStat() and ChildData.getData() will both return null.

Method Detail

values

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

Returns:

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

valueOf

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