com.github.dockerjava.api.async

Class ResultCallbackTemplate<RC_T extends ResultCallback<A_RES_T>,A_RES_T>

java.lang.Object

com.github.dockerjava.api.async.ResultCallbackTemplate<RC_T,A_RES_T>

All Implemented Interfaces:

ResultCallback<A_RES_T>, Closeable, AutoCloseable

Direct Known Subclasses:

BuildImageResultCallback, ResultCallback.Adapter, WaitContainerResultCallback

public abstract class ResultCallbackTemplate<RC_T extends ResultCallback<A_RES_T>,A_RES_T>
extends Object
implements ResultCallback<A_RES_T>

Abstract template implementation of ResultCallback

Author:

Marcus Linke

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.dockerjava.api.async.ResultCallback

ResultCallback.Adapter<A_RES_T>

Constructor Summary

Constructors

Constructor and Description
ResultCallbackTemplate()

Method Summary

Modifier and Type	Method and Description
RC_T	awaitCompletion() Blocks until ResultCallback.onComplete() was called
boolean	awaitCompletion(long timeout, TimeUnit timeUnit) Blocks until ResultCallback.onComplete() was called or the given timeout occurs
RC_T	awaitStarted() Blocks until ResultCallback.onStart(Closeable) was called.
boolean	awaitStarted(long timeout, TimeUnit timeUnit) Blocks until ResultCallback.onStart(Closeable) was called or the given timeout occurs.
void	close()
void	onComplete() Called when processing was finished either by reaching the end or by aborting it
void	onError(Throwable throwable) Called when an exception occurs while processing
void	onStart(Closeable stream) Called when the async processing starts respectively when the response arrives from the server.
protected void	throwFirstError() Throws the first occurred error as a runtime exception

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.dockerjava.api.async.ResultCallback

onNext

Constructor Detail

ResultCallbackTemplate

public ResultCallbackTemplate()

Method Detail

onStart

public void onStart(Closeable stream)

Description copied from interface: ResultCallback

Called when the async processing starts respectively when the response arrives from the server. The passed Closeable can be used to close/interrupt the processing.

Specified by:

onStart in interface ResultCallback<A_RES_T>

onError

public void onError(Throwable throwable)

Description copied from interface: ResultCallback

Called when an exception occurs while processing

Specified by:

onError in interface ResultCallback<A_RES_T>

onComplete

public void onComplete()

Description copied from interface: ResultCallback

Called when processing was finished either by reaching the end or by aborting it

Specified by:

onComplete in interface ResultCallback<A_RES_T>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

awaitCompletion

public RC_T awaitCompletion()
                     throws InterruptedException

Blocks until ResultCallback.onComplete() was called

Throws:

InterruptedException

awaitCompletion

public boolean awaitCompletion(long timeout,
                               TimeUnit timeUnit)
                        throws InterruptedException

Blocks until ResultCallback.onComplete() was called or the given timeout occurs

Returns:

true if completed and false if the waiting time elapsed before ResultCallback.onComplete() was called.

Throws:

InterruptedException

awaitStarted

public RC_T awaitStarted()
                  throws InterruptedException

Blocks until ResultCallback.onStart(Closeable) was called. ResultCallback.onStart(Closeable) is called when the request was processed on the server side and the response is incoming.

Throws:

InterruptedException

awaitStarted

public boolean awaitStarted(long timeout,
                            TimeUnit timeUnit)
                     throws InterruptedException

Blocks until ResultCallback.onStart(Closeable) was called or the given timeout occurs. ResultCallback.onStart(Closeable) is called when the request was processed on the server side and the response is incoming.

Returns:

true if started and false if the waiting time elapsed before ResultCallback.onStart(Closeable) was called.

Throws:

InterruptedException

throwFirstError

protected void throwFirstError()

Throws the first occurred error as a runtime exception

Throws:

DockerException - The first docker based Error

RuntimeException - on any other occurred error