org.apache.curator.framework.imps

Class SetDataBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.SetDataBuilderImpl

All Implemented Interfaces:

Backgroundable<ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>>, BackgroundPathAndBytesable<org.apache.zookeeper.data.Stat>, Compressible<SetDataBackgroundVersionable>, ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>, Idempotentable<SetDataBuilder>, PathAndBytesable<org.apache.zookeeper.data.Stat>, SetDataBuilder, Versionable<BackgroundPathAndBytesable<org.apache.zookeeper.data.Stat>>

public class SetDataBuilderImpl
extends Object
implements SetDataBuilder, ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>

Constructor Summary

Constructors

Constructor and Description
SetDataBuilderImpl(CuratorFrameworkImpl client, Backgrounding backgrounding, int version, boolean compress)

Method Summary

Modifier and Type	Method and Description
SetDataBackgroundVersionable	compressed() Cause the data to be compressed using the configured compression provider
org.apache.zookeeper.data.Stat	forPath(String path) Commit the currently building operation using the given path and the default data for the client (usually a byte[0] unless changed via CuratorFrameworkFactory.Builder#defaultData(byte[])).
org.apache.zookeeper.data.Stat	forPath(String path, byte[] data) Commit the currently building operation using the given path and data
CuratorEventType	getBackgroundEventType() Most events are delivered by operations themselves, so they know their event types.
SetDataBuilder	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.
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground() Perform the action in the background
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback) Perform the action in the background
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Executor executor) Perform the action in the background
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Object context) Perform the action in the background
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground(BackgroundCallback callback, Object context, Executor executor) Perform the action in the background
ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat>	inBackground(Object context) Perform the action in the background
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<org.apache.curator.framework.imps.PathAndBytes> operationAndData)
PathAndBytesable<org.apache.zookeeper.data.Stat>	withUnhandledErrorListener(UnhandledErrorListener listener) Set an error listener for this background operation.
BackgroundPathAndBytesable<org.apache.zookeeper.data.Stat>	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

SetDataBuilderImpl

public SetDataBuilderImpl(CuratorFrameworkImpl client,
                          Backgrounding backgrounding,
                          int version,
                          boolean compress)

Method Detail

compressed

public SetDataBackgroundVersionable compressed()

Description copied from interface: Compressible

Cause the data to be compressed using the configured compression provider

Specified by:

compressed in interface Compressible<SetDataBackgroundVersionable>

Returns:

this

withVersion

public BackgroundPathAndBytesable<org.apache.zookeeper.data.Stat> withVersion(int version)

Description copied from interface: Versionable

Use the given version (the default is -1)

Specified by:

withVersion in interface Versionable<BackgroundPathAndBytesable<org.apache.zookeeper.data.Stat>>

Parameters:

version - version to use

Returns:

this

idempotent

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

Returns:

this:

inBackground

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

Parameters:

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

Returns:

this

inBackground

public ErrorListenerPathAndBytesable<org.apache.zookeeper.data.Stat> inBackground()

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

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

Returns:

this

inBackground

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

Parameters:

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

Returns:

this

inBackground

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

withUnhandledErrorListener

public PathAndBytesable<org.apache.zookeeper.data.Stat> withUnhandledErrorListener(UnhandledErrorListener listener)

Description copied from interface: ErrorListenerPathAndBytesable

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

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<org.apache.curator.framework.imps.PathAndBytes> operationAndData)
                                throws Exception

Throws:

Exception

forPath

public org.apache.zookeeper.data.Stat forPath(String path)
                                       throws Exception

Description copied from interface: PathAndBytesable

Commit the currently building operation using the given path and the default data for the client (usually a byte[0] unless changed via CuratorFrameworkFactory.Builder#defaultData(byte[])).

Specified by:

forPath in interface PathAndBytesable<org.apache.zookeeper.data.Stat>

Parameters:

path - the path

Returns:

operation result if any

Throws:

Exception - errors

forPath

public org.apache.zookeeper.data.Stat forPath(String path,
                                              byte[] data)
                                       throws Exception

Description copied from interface: PathAndBytesable

Commit the currently building operation using the given path and data

Specified by:

forPath in interface PathAndBytesable<org.apache.zookeeper.data.Stat>

Parameters:

path - the path

data - the data

Returns:

operation result if any

Throws:

Exception - errors