T
- the type of value produced by each promise in the batchpublic interface SerialBatch<T> extends Batch<T>
Serial batches can be created via of(java.lang.Iterable<? extends ratpack.exec.Promise<T>>)
.
Serial batches are faster than parallel batches
when the batch size is small and jobs complete quickly.
Modifier and Type | Method and Description |
---|---|
Operation |
forEach(BiAction<? super Integer,? super T> consumer)
Processes the promises of the batch, stopping at the first error, emitting results to the given callback.
|
static <T> SerialBatch<T> |
of(Iterable<? extends Promise<T>> promises)
Creates a new serial batch of the given promises.
|
static <T> SerialBatch<T> |
of(Promise<T>... promises)
Creates a new serial batch of the given promises.
|
TransformablePublisher<T> |
publisher()
Creates a publisher that emits the promised values.
|
Promise<List<T>> |
yield()
Processes all the promises of the batch, stopping at the first error.
|
Promise<List<? extends ExecResult<T>>> |
yieldAll()
Processes all the promises of the batch, collecting any errors.
|
static <T> SerialBatch<T> of(Iterable<? extends Promise<T>> promises)
T
- the type of item produced by each promisepromises
- the promisesSerialBatch
@SafeVarargs static <T> SerialBatch<T> of(Promise<T>... promises)
T
- the type of item produced by each promisepromises
- the promisesSerialBatch
Promise<List<? extends ExecResult<T>>> yieldAll()
This method differs from Batch.yield()
in that every promise will be processed, regardless of any failure.
As such, it returns ExecResult
objects representing the outcome as it may be an error.
The promise returned from this method will not fail, as failure is conveyed via the result objects of the list.
The order of the entries in the promised list corresponds to the order of the promises originally. That is, it is guaranteed that the 2nd item in the list was the 2nd promise specified.
Promise<List<T>> yield()
This method differs from Batch.yieldAll()
in that processing will be halted as soon as the first error occurs.
The error will be propagated through the returned promise.
The order of the entries in the promised list corresponds to the order of the promises originally. That is, it is guaranteed that the 2nd item in the list was the 2nd promise specified. It does not reflect the order in which promises completed.
Operation forEach(BiAction<? super Integer,? super T> consumer)
This method is useful for aggregating or reducing the batch.
The returned operation will complete after all items have been consumed or if there is an error.
The integer value given the to consumer indicates the source position of the corresponding promise.
TransformablePublisher<T> publisher()
This method differs to Batch.yield()
and Batch.yieldAll()
in that items are emitted as soon as they have completed.
As such, it is more appropriate when wanting to stream the results in some fashion.
Items are emitted in completion order, not source order.
Processing is effectively halted when the first error occurs.
The returned publisher is NOT execution bound
.