org.testcontainers.containers.output

Class FrameConsumerResultCallback

java.lang.Object

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

com.github.dockerjava.core.async.ResultCallbackTemplate<FrameConsumerResultCallback,com.github.dockerjava.api.model.Frame>

org.testcontainers.containers.output.FrameConsumerResultCallback

All Implemented Interfaces:

com.github.dockerjava.api.async.ResultCallback<com.github.dockerjava.api.model.Frame>, java.io.Closeable, java.lang.AutoCloseable

public class FrameConsumerResultCallback
extends com.github.dockerjava.core.async.ResultCallbackTemplate<FrameConsumerResultCallback,com.github.dockerjava.api.model.Frame>

This class can be used as a generic callback for docker-java commands that produce Frames.

Nested Class Summary

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

com.github.dockerjava.api.async.ResultCallback.Adapter<A_RES_T>

Constructor Summary

Constructors

Constructor and Description
FrameConsumerResultCallback()

Method Summary

Modifier and Type	Method and Description
void	addConsumer(OutputFrame.OutputType outputType, java.util.function.Consumer<OutputFrame> consumer) Set this callback to use the specified consumer for the given output type.
void	close()
java.util.concurrent.CountDownLatch	getCompletionLatch()
void	onError(java.lang.Throwable throwable)
void	onNext(com.github.dockerjava.api.model.Frame frame)

Methods inherited from class com.github.dockerjava.api.async.ResultCallbackTemplate

awaitCompletion, awaitCompletion, awaitStarted, awaitStarted, onComplete, onStart, throwFirstError

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameConsumerResultCallback

public FrameConsumerResultCallback()

Method Detail

addConsumer

public void addConsumer(OutputFrame.OutputType outputType,
                        java.util.function.Consumer<OutputFrame> consumer)

Set this callback to use the specified consumer for the given output type. The same consumer can be configured for more than one output type.

Parameters:

outputType - the output type to configure

consumer - the consumer to use for that output type

onNext

public void onNext(com.github.dockerjava.api.model.Frame frame)

onError

public void onError(java.lang.Throwable throwable)

Specified by:

onError in interface com.github.dockerjava.api.async.ResultCallback<com.github.dockerjava.api.model.Frame>

Overrides:

onError in class com.github.dockerjava.api.async.ResultCallbackTemplate<FrameConsumerResultCallback,com.github.dockerjava.api.model.Frame>

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class com.github.dockerjava.api.async.ResultCallbackTemplate<FrameConsumerResultCallback,com.github.dockerjava.api.model.Frame>

Throws:

java.io.IOException

getCompletionLatch

public java.util.concurrent.CountDownLatch getCompletionLatch()

Returns:

a CountDownLatch that may be used to wait until close() has been called.