Package org.apache.curator.framework.recipes.cache

Enum PathChildrenCache.StartMode

java.lang.Object

java.lang.Enum<PathChildrenCache.StartMode>

org.apache.curator.framework.recipes.cache.PathChildrenCache.StartMode

Enclosing class:

PathChildrenCache

public static enum PathChildrenCache.StartMode
extends java.lang.Enum<PathChildrenCache.StartMode>

Method of priming cache on PathChildrenCache.start(StartMode)

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUILD_INITIAL_CACHE	The cache will be primed (in the foreground) with initial values.
NORMAL	The cache will be primed (in the background) with initial values.
POST_INITIALIZED_EVENT	After cache is primed with initial values (in the background) a PathChildrenCacheEvent.Type.INITIALIZED will be posted.

Method Summary

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

NORMAL

public static final PathChildrenCache.StartMode NORMAL

The cache will be primed (in the background) with initial values. Events for existing and new nodes will be posted.

BUILD_INITIAL_CACHE

public static final PathChildrenCache.StartMode BUILD_INITIAL_CACHE

The cache will be primed (in the foreground) with initial values. PathChildrenCache.rebuild() will be called before the PathChildrenCache.start(StartMode) method returns in order to get an initial view of the node.

POST_INITIALIZED_EVENT

public static final PathChildrenCache.StartMode POST_INITIALIZED_EVENT

After cache is primed with initial values (in the background) a PathChildrenCacheEvent.Type.INITIALIZED will be posted.

Method Detail

values

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

Returns:

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

valueOf

public static PathChildrenCache.StartMode 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