com.netflix.curator.framework.recipes.cache
Enum PathChildrenCache.StartMode

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<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

BUILD_INITIAL_CACHE
PathChildrenCache.rebuild() will be called before this method returns in order to get an initial view of the node.

NORMAL
cache will _not_ be primed.

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

Method Summary

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

cache will _not_ be primed. i.e. it will start empty and you will receive events for all nodes added, etc.

BUILD_INITIAL_CACHE

public static final PathChildrenCache.StartMode BUILD_INITIAL_CACHE

PathChildrenCache.rebuild() will be called before this 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