Package org.apache.curator.framework.imps

Class RemoveWatchesBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.RemoveWatchesBuilderImpl

All Implemented Interfaces:

Backgroundable<ErrorListenerPathable<Void>>, BackgroundPathable<Void>, BackgroundPathableQuietlyable<Void>, ErrorListenerPathable<Void>, Guaranteeable<BackgroundPathableQuietlyable<Void>>, Pathable<Void>, Quietly<BackgroundPathable<Void>>, RemoveWatchesBuilder, RemoveWatchesLocal, RemoveWatchesType

Direct Known Subclasses:

WatchesBuilderImpl

public class RemoveWatchesBuilderImpl
extends Object
implements RemoveWatchesBuilder, RemoveWatchesType, RemoveWatchesLocal, ErrorListenerPathable<Void>

Constructor Summary

Constructors

Constructor	Description
RemoveWatchesBuilderImpl(CuratorFrameworkBase client)
RemoveWatchesBuilderImpl(CuratorFrameworkBase client, org.apache.zookeeper.Watcher watcher, CuratorWatcher curatorWatcher, org.apache.zookeeper.Watcher.WatcherType watcherType, boolean guaranteed, boolean local, boolean quietly, Backgrounding backgrounding)

Method Summary

Modifier and Type	Method	Description
Void	forPath(String path)	Commit the currently building operation using the given path
CuratorEventType	getBackgroundEventType()
protected CuratorFrameworkBase	getClient()
RemoveWatchesLocal	guaranteed()	Solves edge cases where an operation may succeed on the server but connection failure occurs before a response can be successfully returned to the client.
ErrorListenerPathable<Void>	inBackground()	Perform the action in the background
ErrorListenerPathable<Void>	inBackground(Object context)	Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback)	Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback, Object context)	Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback, Object context, Executor executor)	Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback, Executor executor)	Perform the action in the background
BackgroundPathableQuietlyable<Void>	locally()	Specify if the client should just remove client side watches if a connection to ZK is not available.
RemoveWatchesLocal	ofType(org.apache.zookeeper.Watcher.WatcherType watcherType)	Specify the type of watcher to be removed.
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> operationAndData)
BackgroundPathable<Void>	quietly()
RemoveWatchesType	remove(CuratorWatcher watcher)	Specify the watcher to be removed
RemoveWatchesType	remove(org.apache.zookeeper.Watcher watcher)	Specify the watcher to be removed
RemoveWatchesType	removeAll()	Specify that all watches should be removed
Pathable<Void>	withUnhandledErrorListener(UnhandledErrorListener listener)	Set an error listener for this background operation.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoveWatchesBuilderImpl

public RemoveWatchesBuilderImpl(CuratorFrameworkBase client)

RemoveWatchesBuilderImpl

public RemoveWatchesBuilderImpl(CuratorFrameworkBase client,
 org.apache.zookeeper.Watcher watcher,
 CuratorWatcher curatorWatcher,
 org.apache.zookeeper.Watcher.WatcherType watcherType,
 boolean guaranteed,
 boolean local,
 boolean quietly,
 Backgrounding backgrounding)

Method Details

remove

public RemoveWatchesType remove(org.apache.zookeeper.Watcher watcher)

Description copied from interface: RemoveWatchesBuilder

Specify the watcher to be removed

Specified by:

remove in interface RemoveWatchesBuilder

Parameters:

watcher -

Returns:

remove

public RemoveWatchesType remove(CuratorWatcher watcher)

Description copied from interface: RemoveWatchesBuilder

Specify the watcher to be removed

Specified by:

remove in interface RemoveWatchesBuilder

Parameters:

watcher -

Returns:

removeAll

public RemoveWatchesType removeAll()

Description copied from interface: RemoveWatchesBuilder

Specify that all watches should be removed

Specified by:

removeAll in interface RemoveWatchesBuilder

Returns:

ofType

public RemoveWatchesLocal ofType(org.apache.zookeeper.Watcher.WatcherType watcherType)

Description copied from interface: RemoveWatchesType

Specify the type of watcher to be removed.

Specified by:

ofType in interface RemoveWatchesType

Parameters:

watcherType -

Returns:

inBackground

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

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<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 ErrorListenerPathable<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<ErrorListenerPathable<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

inBackground

public ErrorListenerPathable<Void> inBackground(BackgroundCallback callback)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<Void>>

Parameters:

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

Returns:

this

inBackground

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

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<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 ErrorListenerPathable<Void> inBackground()

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<Void>>

Returns:

this

inBackground

public ErrorListenerPathable<Void> inBackground(Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<Void>>

Parameters:

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

Returns:

this

withUnhandledErrorListener

public Pathable<Void> withUnhandledErrorListener(UnhandledErrorListener listener)

Description copied from interface: ErrorListenerPathable

Set an error listener for this background operation. If an exception occurs while processing the call in the background, this listener will be called.

Specified by:

withUnhandledErrorListener in interface ErrorListenerPathable<Void>

Parameters:

listener - the listener

Returns:

this for chaining

guaranteed

public RemoveWatchesLocal guaranteed()

Description copied from interface: Guaranteeable

Solves edge cases where an operation may succeed on the server but connection failure occurs before a response can be successfully returned to the client.

Specified by:

guaranteed in interface Guaranteeable<BackgroundPathableQuietlyable<Void>>

Returns:

this

See Also:

• GuaranteeableDeletable

locally

public BackgroundPathableQuietlyable<Void> locally()

Description copied from interface: RemoveWatchesLocal

Specify if the client should just remove client side watches if a connection to ZK is not available. Note that the standard Curator retry loop will not be used in t

Specified by:

locally in interface RemoveWatchesLocal

Returns:

quietly

public BackgroundPathable<Void> quietly()

Specified by:

quietly in interface Quietly<BackgroundPathable<Void>>

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

getClient

protected CuratorFrameworkBase getClient()

getBackgroundEventType

public CuratorEventType getBackgroundEventType()

performBackgroundOperation

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

Throws:

Exception