Package org.apache.curator.framework.imps

Class ExistsBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.ExistsBuilderImpl

All Implemented Interfaces:

ACLable<ExistsBuilderMain>, ACLableExistBuilderMain, Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>, BackgroundPathable<org.apache.zookeeper.data.Stat>, ErrorListenerPathable<org.apache.zookeeper.data.Stat>, ExistsBuilder, ExistsBuilderMain, Pathable<org.apache.zookeeper.data.Stat>, Watchable<BackgroundPathable<org.apache.zookeeper.data.Stat>>, WatchableBase<BackgroundPathable<org.apache.zookeeper.data.Stat>>

public class ExistsBuilderImpl
extends Object
implements ExistsBuilder, ErrorListenerPathable<org.apache.zookeeper.data.Stat>, ACLableExistBuilderMain

Constructor Summary

Constructors

Constructor	Description
ExistsBuilderImpl(CuratorFrameworkBase client, Backgrounding backgrounding, org.apache.zookeeper.Watcher watcher, boolean createParentsIfNeeded, boolean createParentContainersIfNeeded)

Method Summary

Modifier and Type	Method	Description
ACLableExistBuilderMain	creatingParentContainersIfNeeded()	Causes any parent nodes to get created using CreateMode.CONTAINER if they haven't already been.
ACLableExistBuilderMain	creatingParentsIfNeeded()	Causes any parent nodes to get created if they haven't already been
org.apache.zookeeper.data.Stat	forPath(String path)	Commit the currently building operation using the given path
CuratorEventType	getBackgroundEventType()
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground()	Perform the action in the background
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground(Object context)	Perform the action in the background
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback)	Perform the action in the background
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Object context)	Perform the action in the background
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Object context, Executor executor)	Perform the action in the background
ErrorListenerPathable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Executor executor)	Perform the action in the background
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> operationAndData)
BackgroundPathable<org.apache.zookeeper.data.Stat>	usingWatcher(CuratorWatcher watcher)	Set a watcher for the operation
BackgroundPathable<org.apache.zookeeper.data.Stat>	usingWatcher(org.apache.zookeeper.Watcher watcher)	Set a watcher for the operation
BackgroundPathable<org.apache.zookeeper.data.Stat>	watched()	Have the operation set a watch
ExistsBuilderMain	withACL(List<org.apache.zookeeper.data.ACL> aclList)	Set an ACL list (default is ZooDefs.Ids.OPEN_ACL_UNSAFE)
Pathable<org.apache.zookeeper.data.Stat>	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

ExistsBuilderImpl

public ExistsBuilderImpl(CuratorFrameworkBase client,
 Backgrounding backgrounding,
 org.apache.zookeeper.Watcher watcher,
 boolean createParentsIfNeeded,
 boolean createParentContainersIfNeeded)

Method Details

creatingParentsIfNeeded

public ACLableExistBuilderMain creatingParentsIfNeeded()

Description copied from interface: ExistsBuilder

Causes any parent nodes to get created if they haven't already been

Specified by:

creatingParentsIfNeeded in interface ExistsBuilder

Returns:

this

creatingParentContainersIfNeeded

public ACLableExistBuilderMain creatingParentContainersIfNeeded()

Description copied from interface: ExistsBuilder

Causes any parent nodes to get created using CreateMode.CONTAINER if they haven't already been. IMPORTANT NOTE: container creation is a new feature in recent versions of ZooKeeper. If the ZooKeeper version you're using does not support containers, the parent nodes are created as ordinary PERSISTENT nodes.

Specified by:

creatingParentContainersIfNeeded in interface ExistsBuilder

Returns:

this

withACL

public ExistsBuilderMain withACL(List<org.apache.zookeeper.data.ACL> aclList)

Description copied from interface: ACLable

Set an ACL list (default is ZooDefs.Ids.OPEN_ACL_UNSAFE)

Specified by:

withACL in interface ACLable<ExistsBuilderMain>

Parameters:

aclList - the ACL list to use

Returns:

this

watched

public BackgroundPathable<org.apache.zookeeper.data.Stat> watched()

Description copied from interface: Watchable

Have the operation set a watch

Specified by:

watched in interface Watchable<BackgroundPathable<org.apache.zookeeper.data.Stat>>

Returns:

this

usingWatcher

public BackgroundPathable<org.apache.zookeeper.data.Stat> usingWatcher(org.apache.zookeeper.Watcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<BackgroundPathable<org.apache.zookeeper.data.Stat>>

Parameters:

watcher - the watcher

Returns:

this

usingWatcher

public BackgroundPathable<org.apache.zookeeper.data.Stat> usingWatcher(CuratorWatcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<BackgroundPathable<org.apache.zookeeper.data.Stat>>

Parameters:

watcher - the watcher

Returns:

this

inBackground

public ErrorListenerPathable<org.apache.zookeeper.data.Stat> inBackground(BackgroundCallback callback,
 Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>

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<org.apache.zookeeper.data.Stat> 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<org.apache.zookeeper.data.Stat>>

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<org.apache.zookeeper.data.Stat> inBackground(BackgroundCallback callback)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>

Parameters:

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

Returns:

this

inBackground

public ErrorListenerPathable<org.apache.zookeeper.data.Stat> inBackground(BackgroundCallback callback,
 Executor executor)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>

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<org.apache.zookeeper.data.Stat> inBackground()

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>

Returns:

this

inBackground

public ErrorListenerPathable<org.apache.zookeeper.data.Stat> inBackground(Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<org.apache.zookeeper.data.Stat>>

Parameters:

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

Returns:

this

withUnhandledErrorListener

public Pathable<org.apache.zookeeper.data.Stat> 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<org.apache.zookeeper.data.Stat>

Parameters:

listener - the listener

Returns:

this for chaining

getBackgroundEventType

public CuratorEventType getBackgroundEventType()

performBackgroundOperation

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

Throws:

Exception

forPath

public org.apache.zookeeper.data.Stat 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<org.apache.zookeeper.data.Stat>

Parameters:

path - the path

Returns:

operation result if any

Throws:

Exception - errors