org.apache.curator.framework.imps

Class GetDataBuilderImpl

java.lang.Object

org.apache.curator.framework.imps.GetDataBuilderImpl

All Implemented Interfaces:

Backgroundable<ErrorListenerPathable<byte[]>>, BackgroundPathable<byte[]>, Decompressible<GetDataWatchBackgroundStatable>, ErrorListenerPathable<byte[]>, GetDataBuilder, Pathable<byte[]>, Statable<WatchPathable<byte[]>>, Watchable<BackgroundPathable<byte[]>>, WatchableBase<BackgroundPathable<byte[]>>

public class GetDataBuilderImpl
extends Object
implements GetDataBuilder, ErrorListenerPathable<byte[]>

Constructor Summary

Constructors

Constructor and Description
GetDataBuilderImpl(CuratorFrameworkImpl client, org.apache.zookeeper.data.Stat responseStat, org.apache.zookeeper.Watcher watcher, Backgrounding backgrounding, boolean decompress)

Method Summary

Modifier and Type	Method and Description
GetDataWatchBackgroundStatable	decompressed() Cause the data to be de-compressed using the configured compression provider
byte[]	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.
ErrorListenerPathable<byte[]>	inBackground() Perform the action in the background
ErrorListenerPathable<byte[]>	inBackground(BackgroundCallback callback) Perform the action in the background
ErrorListenerPathable<byte[]>	inBackground(BackgroundCallback callback, Executor executor) Perform the action in the background
ErrorListenerPathable<byte[]>	inBackground(BackgroundCallback callback, Object context) Perform the action in the background
ErrorListenerPathable<byte[]>	inBackground(BackgroundCallback callback, Object context, Executor executor) Perform the action in the background
ErrorListenerPathable<byte[]>	inBackground(Object context) Perform the action in the background
void	performBackgroundOperation(org.apache.curator.framework.imps.OperationAndData<String> operationAndData)
WatchPathable<byte[]>	storingStatIn(org.apache.zookeeper.data.Stat stat) Have the operation fill the provided stat object
BackgroundPathable<byte[]>	usingWatcher(CuratorWatcher watcher) Set a watcher for the operation
BackgroundPathable<byte[]>	usingWatcher(org.apache.zookeeper.Watcher watcher) Set a watcher for the operation
BackgroundPathable<byte[]>	watched() Have the operation set a watch
Pathable<byte[]>	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 Detail

GetDataBuilderImpl

public GetDataBuilderImpl(CuratorFrameworkImpl client,
                          org.apache.zookeeper.data.Stat responseStat,
                          org.apache.zookeeper.Watcher watcher,
                          Backgrounding backgrounding,
                          boolean decompress)

Method Detail

decompressed

public GetDataWatchBackgroundStatable decompressed()

Description copied from interface: Decompressible

Cause the data to be de-compressed using the configured compression provider

Specified by:

decompressed in interface Decompressible<GetDataWatchBackgroundStatable>

Returns:

this

storingStatIn

public WatchPathable<byte[]> storingStatIn(org.apache.zookeeper.data.Stat stat)

Description copied from interface: Statable

Have the operation fill the provided stat object

Specified by:

storingStatIn in interface Statable<WatchPathable<byte[]>>

Parameters:

stat - the stat to have filled in

Returns:

this

inBackground

public ErrorListenerPathable<byte[]> inBackground(BackgroundCallback callback,
                                                  Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<byte[]>>

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<byte[]> 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<byte[]>>

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<byte[]> inBackground(BackgroundCallback callback)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<byte[]>>

Parameters:

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

Returns:

this

inBackground

public ErrorListenerPathable<byte[]> inBackground(BackgroundCallback callback,
                                                  Executor executor)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<byte[]>>

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<byte[]> inBackground()

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<byte[]>>

Returns:

this

inBackground

public ErrorListenerPathable<byte[]> inBackground(Object context)

Description copied from interface: Backgroundable

Perform the action in the background

Specified by:

inBackground in interface Backgroundable<ErrorListenerPathable<byte[]>>

Parameters:

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

Returns:

this

withUnhandledErrorListener

public Pathable<byte[]> 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<byte[]>

Parameters:

listener - the listener

Returns:

this for chaining

watched

public BackgroundPathable<byte[]> watched()

Description copied from interface: Watchable

Have the operation set a watch

Specified by:

watched in interface Watchable<BackgroundPathable<byte[]>>

Returns:

this

usingWatcher

public BackgroundPathable<byte[]> usingWatcher(org.apache.zookeeper.Watcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<BackgroundPathable<byte[]>>

Parameters:

watcher - the watcher

Returns:

this

usingWatcher

public BackgroundPathable<byte[]> usingWatcher(CuratorWatcher watcher)

Description copied from interface: WatchableBase

Set a watcher for the operation

Specified by:

usingWatcher in interface WatchableBase<BackgroundPathable<byte[]>>

Parameters:

watcher - the watcher

Returns:

this

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 byte[] 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<byte[]>

Parameters:

path - the path

Returns:

operation result if any

Throws:

Exception - errors