com.ibm.cos.v2.core.internal.async

Class SplittingTransformer.Builder<ResponseT,ResultT>

java.lang.Object

com.ibm.cos.v2.core.internal.async.SplittingTransformer.Builder<ResponseT,ResultT>

Enclosing class:

SplittingTransformer<ResponseT,ResultT>

public static final class SplittingTransformer.Builder<ResponseT,ResultT>
extends Object

Method Summary

Modifier and Type	Method and Description
SplittingTransformer<ResponseT,ResultT>	build()
SplittingTransformer.Builder<ResponseT,ResultT>	maximumBufferSizeInBytes(Long maximumBufferSize) The amount of data in byte this publisher will buffer into memory before sending it to the upstream transformer.
SplittingTransformer.Builder<ResponseT,ResultT>	resultFuture(CompletableFuture<ResultT> returnFuture) The future that will be completed when the future which is returned by the call to AsyncResponseTransformer.prepare() completes.
SplittingTransformer.Builder<ResponseT,ResultT>	upstreamResponseTransformer(AsyncResponseTransformer<ResponseT,ResultT> upstreamResponseTransformer) The AsyncResponseTransformer that will receive the data from each of the individually published IndividualTransformer, usually intended to be the one on which the AsyncResponseTransformer.split(SplittingTransformerConfiguration))} method was called.

Methods inherited from class java.lang.Object

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

Method Detail

upstreamResponseTransformer

public SplittingTransformer.Builder<ResponseT,ResultT> upstreamResponseTransformer(AsyncResponseTransformer<ResponseT,ResultT> upstreamResponseTransformer)

The AsyncResponseTransformer that will receive the data from each of the individually published IndividualTransformer, usually intended to be the one on which the AsyncResponseTransformer.split(SplittingTransformerConfiguration))} method was called.

Parameters:

upstreamResponseTransformer - the AsyncResponseTransformer that was split.

Returns:

an instance of this builder

maximumBufferSizeInBytes

public SplittingTransformer.Builder<ResponseT,ResultT> maximumBufferSizeInBytes(Long maximumBufferSize)

The amount of data in byte this publisher will buffer into memory before sending it to the upstream transformer. The data will be sent if chunk of maximumBufferSize to the upstream transformer unless the subscription is cancelled while less amount is buffered, in which case a chunk with a size less than maximumBufferSize will be sent.

Parameters:

maximumBufferSize - the amount of data buffered and the size of the chunk of data

Returns:

an instance of this builder

resultFuture

public SplittingTransformer.Builder<ResponseT,ResultT> resultFuture(CompletableFuture<ResultT> returnFuture)

The future that will be completed when the future which is returned by the call to AsyncResponseTransformer.prepare() completes.

Parameters:

returnFuture - the future to complete.

Returns:

an instance of this builder

build

public SplittingTransformer<ResponseT,ResultT> build()