org.apache.curator.framework.imps

Class AddWatchBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.AddWatchBuilderImpl

All Implemented Interfaces:

AddWatchBuilder, AddWatchBuilder2, Backgroundable<WatchableBase<Pathable<Void>>>, Pathable<Void>, WatchableBase<Pathable<Void>>

public class AddWatchBuilderImpl
extends Object
implements AddWatchBuilder, Pathable<Void>

Constructor Summary

Constructors

Constructor and Description
AddWatchBuilderImpl(CuratorFrameworkImpl client, Watching watching, Backgrounding backgrounding, org.apache.zookeeper.AddWatchMode mode)

Method Summary

Modifier and Type	Method and Description
Void	forPath(String path) Commit the currently building operation using the given path
CuratorEventType	getBackgroundEventType() Most events are delivered by operations themselves, so they know their event types.
WatchableBase<Pathable<Void>>	inBackground() Perform the action in the background
WatchableBase<Pathable<Void>>	inBackground(BackgroundCallback callback) Perform the action in the background
WatchableBase<Pathable<Void>>	inBackground(BackgroundCallback callback, Executor executor) Perform the action in the background
WatchableBase<Pathable<Void>>	inBackground(BackgroundCallback callback, Object context) Perform the action in the background
WatchableBase<Pathable<Void>>	inBackground(BackgroundCallback callback, Object context, Executor executor) Perform the action in the background
WatchableBase<Pathable<Void>>	inBackground(Object context) Perform the action in the background
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> data)
Pathable<Void>	usingWatcher(CuratorWatcher watcher) Set a watcher for the operation
Pathable<Void>	usingWatcher(org.apache.zookeeper.Watcher watcher) Set a watcher for the operation
AddWatchBuilder2	withMode(org.apache.zookeeper.AddWatchMode mode) The mode to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddWatchBuilderImpl

public AddWatchBuilderImpl(CuratorFrameworkImpl client,
                           Watching watching,
                           Backgrounding backgrounding,
                           org.apache.zookeeper.AddWatchMode mode)

Method Detail

inBackground

public WatchableBase<Pathable<Void>> inBackground()

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Returns:

this

withMode

public AddWatchBuilder2 withMode(org.apache.zookeeper.AddWatchMode mode)

Description copied from interface: AddWatchBuilder

The mode to use. By default, AddWatchMode.PERSISTENT_RECURSIVE is used

Specified by:

withMode in interface AddWatchBuilder

Parameters:

mode - mode to use

Returns:

this

usingWatcher

public Pathable<Void> usingWatcher(org.apache.zookeeper.Watcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<Pathable<Void>>

Parameters:

watcher - the watcher

Returns:

this

usingWatcher

public Pathable<Void> usingWatcher(CuratorWatcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<Pathable<Void>>

Parameters:

watcher - the watcher

Returns:

this

inBackground

public WatchableBase<Pathable<Void>> inBackground(Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Parameters:

context - context object - will be available from the event sent to the listener

Returns:

this

inBackground

public WatchableBase<Pathable<Void>> inBackground(BackgroundCallback callback)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Parameters:

callback - a functor that will get called when the operation has completed

Returns:

this

inBackground

public WatchableBase<Pathable<Void>> inBackground(BackgroundCallback callback,
                                                  Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Parameters:

callback - a functor that will get called when the operation has completed

context - context object - will be available from the event sent to the listener

Returns:

this

inBackground

public WatchableBase<Pathable<Void>> inBackground(BackgroundCallback callback,
                                                  Executor executor)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Parameters:

callback - a functor that will get called when the operation has completed

executor - executor to use for the background call

Returns:

this

inBackground

public WatchableBase<Pathable<Void>> inBackground(BackgroundCallback callback,
                                                  Object context,
                                                  Executor executor)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<WatchableBase<Pathable<Void>>>

Parameters:

callback - a functor that will get called when the operation has completed

context - context object - will be available from the event sent to the listener

executor - executor to use for the background call

Returns:

this

forPath

public Void forPath(String path)
             throws Exception

Description copied from interface: Pathable

Commit the currently building operation using the given path

Specified by:

forPath in interface Pathable<Void>

Parameters:

path - the path

Returns:

operation result if any

Throws:

Exception - errors

getBackgroundEventType

public CuratorEventType getBackgroundEventType()

Most events are delivered by operations themselves, so they know their event types. But in occasional cases(says, closing or background exception), events are delivered by curator framework.

performBackgroundOperation

public void performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> data)
                                throws Exception

Throws:

Exception