org.apache.curator.framework.imps

Class DeleteBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.DeleteBuilderImpl

All Implemented Interfaces:

Backgroundable<ErrorListenerPathable<Void>>, BackgroundPathable<Void>, BackgroundVersionable, ChildrenDeletable, DeleteBuilder, DeleteBuilderMain, ErrorListenerPathable<Void>, Guaranteeable<ChildrenDeletable>, GuaranteeableDeletable, Idempotentable<DeleteBuilderMain>, Pathable<Void>, Quietly<DeleteBuilderMain>, Versionable<BackgroundPathable<Void>>

public class DeleteBuilderImpl
extends Object
implements DeleteBuilder, ErrorListenerPathable<Void>

Constructor Summary

Constructors

Constructor and Description
DeleteBuilderImpl(CuratorFrameworkImpl client, int version, Backgrounding backgrounding, boolean deletingChildrenIfNeeded, boolean guaranteed, boolean quietly)

Method Summary

Modifier and Type	Method and Description
BackgroundVersionable	deletingChildrenIfNeeded() Will also delete children if they exist.
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.
protected int	getVersion()
ChildrenDeletable	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.
DeleteBuilderMain	idempotent() If the first try of this operation gets a transient error, curator will retry the operation, and treat it as successful so long as the end state of the znode is the same as if the operation had completed without error on the first try.
ErrorListenerPathable<Void>	inBackground() Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback) Perform the action in the background
ErrorListenerPathable<Void>	inBackground(BackgroundCallback callback, Executor executor) 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(Object context) Perform the action in the background
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> operationAndData)
DeleteBuilderMain	quietly()
Pathable<Void>	withUnhandledErrorListener(UnhandledErrorListener listener) Set an error listener for this background operation.
BackgroundPathable<Void>	withVersion(int version) Use the given version (the default is -1)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteBuilderImpl

public DeleteBuilderImpl(CuratorFrameworkImpl client,
                         int version,
                         Backgrounding backgrounding,
                         boolean deletingChildrenIfNeeded,
                         boolean guaranteed,
                         boolean quietly)

Method Detail

quietly

public DeleteBuilderMain quietly()

Specified by:

quietly in interface Quietly<DeleteBuilderMain>

idempotent

public DeleteBuilderMain idempotent()

Description copied from interface: Idempotentable

If the first try of this operation gets a transient error, curator will retry the operation, and treat it as successful so long as the end state of the znode is the same as if the operation had completed without error on the first try.

Specified by:

idempotent in interface Idempotentable<DeleteBuilderMain>

Returns:

this:

guaranteed

public ChildrenDeletable 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<ChildrenDeletable>

Returns:

this

See Also:

GuaranteeableDeletable

deletingChildrenIfNeeded

public BackgroundVersionable deletingChildrenIfNeeded()

Description copied from interface: ChildrenDeletable

Will also delete children if they exist.

Specified by:

deletingChildrenIfNeeded in interface ChildrenDeletable

Returns:

withVersion

public BackgroundPathable<Void> withVersion(int version)

Description copied from interface: Versionable

Use the given version (the default is -1)

Specified by:

withVersion in interface Versionable<BackgroundPathable<Void>>

Parameters:

version - version to use

Returns:

this

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

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> operationAndData)
                                throws Exception

Throws:

Exception

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

getVersion

protected int getVersion()