Interface SerialBatch<T>

    • Method Detail

      • of

        static <T> SerialBatch<T> of​(Iterable<? extends Promise<? extends T>> promises)
        Creates a new serial batch of the given promises.
        Type Parameters:
        T - the type of item produced by each promise
        Parameters:
        promises - the promises
        Returns:
        a SerialBatch
      • of

        @SafeVarargs
        static <T> SerialBatch<T> of​(Promise<? extends T>... promises)
        Creates a new serial batch of the given promises.
        Type Parameters:
        T - the type of item produced by each promise
        Parameters:
        promises - the promises
        Returns:
        a SerialBatch
      • yieldAll

        Promise<List<? extends ExecResult<T>>> yieldAll()
        Processes all the promises of the batch, collecting any errors.

        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.

        Specified by:
        yieldAll in interface Batch<T>
        Returns:
        a promise for the result of each promise
      • yield

        Promise<List<T>> yield()
        Processes all the promises of the batch, stopping at the first error.

        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.

        Specified by:
        yield in interface Batch<T>
        Returns:
        a promise for each promised value
      • forEach

        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.

        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.

        Specified by:
        forEach in interface Batch<T>
        Parameters:
        consumer - the consumer of promise values
        Returns:
        an operation for the consumption of the values
      • publisher

        TransformablePublisher<T> publisher()
        Creates a publisher that emits the promised values.

        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.

        Specified by:
        publisher in interface Batch<T>
        Returns:
        a publisher for the batch