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

Interface CuratorCacheListenerBuilder

public interface CuratorCacheListenerBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CuratorCacheListenerBuilder.ChangeListener

Method Summary

Modifier and Type	Method	Description
CuratorCacheListenerBuilder	afterInitialized()	Make the built listener so that it only becomes active once CuratorCacheListener.initialized() has been called.
CuratorCacheListener	build()	Build and return a new listener based on the methods that have been previously called
CuratorCacheListenerBuilder	forAll(CuratorCacheListener listener)	Add a standard listener
CuratorCacheListenerBuilder	forChanges(CuratorCacheListenerBuilder.ChangeListener listener)	Add a listener only for CuratorCacheListener.Type.NODE_CHANGED
CuratorCacheListenerBuilder	forCreates(Consumer<ChildData> listener)	Add a listener only for CuratorCacheListener.Type.NODE_CREATED
CuratorCacheListenerBuilder	forCreatesAndChanges(CuratorCacheListenerBuilder.ChangeListener listener)	Add a listener only both CuratorCacheListener.Type.NODE_CREATED and CuratorCacheListener.Type.NODE_CHANGED
CuratorCacheListenerBuilder	forDeletes(Consumer<ChildData> listener)	Add a listener only for CuratorCacheListener.Type.NODE_DELETED
CuratorCacheListenerBuilder	forInitialized(Runnable listener)	Add a listener only for CuratorCacheListener.initialized()
CuratorCacheListenerBuilder	forNodeCache(NodeCacheListener listener)	Bridge listener.
CuratorCacheListenerBuilder	forPathChildrenCache(String rootPath, CuratorFramework client, PathChildrenCacheListener listener)	Bridge listener.
CuratorCacheListenerBuilder	forTreeCache(CuratorFramework client, TreeCacheListener listener)	Bridge listener.

Method Details

forAll

CuratorCacheListenerBuilder forAll(CuratorCacheListener listener)

Add a standard listener

Parameters:

listener - listener to add

Returns:

this

forCreates

CuratorCacheListenerBuilder forCreates(Consumer<ChildData> listener)

Add a listener only for CuratorCacheListener.Type.NODE_CREATED

Parameters:

listener - listener to add

Returns:

this

forChanges

CuratorCacheListenerBuilder forChanges(CuratorCacheListenerBuilder.ChangeListener listener)

Add a listener only for CuratorCacheListener.Type.NODE_CHANGED

Parameters:

listener - listener to add

Returns:

this

forCreatesAndChanges

CuratorCacheListenerBuilder forCreatesAndChanges(CuratorCacheListenerBuilder.ChangeListener listener)

Add a listener only both CuratorCacheListener.Type.NODE_CREATED and CuratorCacheListener.Type.NODE_CHANGED

Parameters:

listener - listener to add

Returns:

this

forDeletes

CuratorCacheListenerBuilder forDeletes(Consumer<ChildData> listener)

Add a listener only for CuratorCacheListener.Type.NODE_DELETED

Parameters:

listener - listener to add

Returns:

this

forInitialized

CuratorCacheListenerBuilder forInitialized(Runnable listener)

Add a listener only for CuratorCacheListener.initialized()

Parameters:

listener - listener to add

Returns:

this

forPathChildrenCache

CuratorCacheListenerBuilder forPathChildrenCache(String rootPath,
 CuratorFramework client,
 PathChildrenCacheListener listener)

Bridge listener. You can reuse old-style PathChildrenCacheListeners with CuratorCache. IMPORTANT: the connection state methods in the listener will never be called as CuratorCache does not register the listener with the connection state listener container. Also note that CuratorCache behaves differently than PathChildrenCache so things such as event ordering will likely be different.

Parameters:

rootPath - the root path. The listener needs this information in order to bridge only events for children of this path and not the path itself

client - the curator client

listener - the listener to wrap

Returns:

a CuratorCacheListener that forwards to the given listener

forTreeCache

CuratorCacheListenerBuilder forTreeCache(CuratorFramework client,
 TreeCacheListener listener)

Bridge listener. You can reuse old-style TreeCacheListeners with CuratorCache. IMPORTANT: the connection state methods in the listener will never be called as CuratorCache does not register the listener with the connection state listener container. Also note that CuratorCache behaves differently than TreeCache so things such as event ordering will likely be different.

Parameters:

client - the curator client

listener - the listener to wrap

Returns:

a CuratorCacheListener that forwards to the given listener

forNodeCache

CuratorCacheListenerBuilder forNodeCache(NodeCacheListener listener)

Bridge listener. You can reuse old-style NodeCacheListeners with CuratorCache.

Parameters:

listener - the listener to wrap

Returns:

a CuratorCacheListener that forwards to the given listener

afterInitialized

CuratorCacheListenerBuilder afterInitialized()

Make the built listener so that it only becomes active once CuratorCacheListener.initialized() has been called. i.e. changes that occur as the cache is initializing are not sent to the listener

build

CuratorCacheListener build()

Build and return a new listener based on the methods that have been previously called

Returns:

new listener