Interface IIntermediateFuture<E>

    • Field Detail

      • DONE

        static final IntermediateFuture<java.lang.Void> DONE
        A future representing a completed action. Can be used as direct return value of methods that do not perform asynchronous operations and do not return a result value.
    • Method Detail

      • getIntermediateResults

        java.util.Collection<E> getIntermediateResults()
        Get the intermediate results that are currently available. Non-blocking method.
        Returns:
        The future result.
      • hasNextIntermediateResult

        boolean hasNextIntermediateResult()
        Check if there are more results for iteration for the given caller. If there are currently no unprocessed results and future is not yet finished, the caller is blocked until either new results are available and true is returned or the future is finished, thus returning false.
        Returns:
        True, when there are more intermediate results for the caller.
      • hasNextIntermediateResult

        boolean hasNextIntermediateResult​(long timeout,
                                          boolean realtime)
        Check if there are more results for iteration for the given caller. If there are currently no unprocessed results and future is not yet finished, the caller is blocked until either new results are available and true is returned or the future is finished, thus returning false.
        Parameters:
        timeout - The timeout in millis.
        realtime - Flag, if wait should be realtime (in constrast to simulation time).
        Returns:
        True, when there are more intermediate results for the caller.
      • getNextIntermediateResult

        E getNextIntermediateResult()
        Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called from different threads, each thread receives all intermediate results. The operation is guaranteed to be non-blocking, if hasNextIntermediateResult() has returned true before for the same caller. Otherwise the caller is blocked until a result is available or the future is finished.
        Returns:
        The next intermediate result.
      • getNextIntermediateResult

        E getNextIntermediateResult​(long timeout,
                                    boolean realtime)
        Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called from different threads, each thread receives all intermediate results. The operation is guaranteed to be non-blocking, if hasNextIntermediateResult() has returned true before for the same caller. Otherwise the caller is blocked until a result is available or the future is finished.
        Parameters:
        timeout - The timeout in millis.
        realtime - Flag, if wait should be realtime (in constrast to simulation time).
        Returns:
        The next intermediate result.
      • next

        IIntermediateFuture<? extends E> next​(Consumer<? super E> function)
        Deprecated.
        Add a functional result listener, which called on intermediate results. Exceptions will be logged.
        Parameters:
        ilistener - The intermediate listener. / public void addIntermediateResultListener(IFunctionalIntermediateResultListener
        ilistener - The intermediate listener.
        flistener - The finished listener, called when no more intermediate results will arrive. If null, the finish event will be ignored. / public void addIntermediateResultListener(IFunctionalIntermediateResultListener
        ilistener - The intermediate listener.
        elistener - The listener that is called on exceptions. Passing null enables default exception logging. / public void addIntermediateResultListener(IFunctionalIntermediateResultListener
        ilistener - The intermediate listener.
        flistener - The finished listener, called when no more intermediate results will arrive. If null, the finish event will be ignored.
        elistener - The listener that is called on exceptions. Passing null enables default exception logging. / public void addIntermediateResultListener(IFunctionalIntermediateResultListener
      • mapAsync

        <R> IIntermediateFuture<R> mapAsync​(Function<E,​IFuture<R>> function)
        Implements async loop and applies a an async function to each element.
        Parameters:
        function - The function.
        Returns:
        True result intermediate future.
      • mapAsync

        <R> IIntermediateFuture<R> mapAsync​(Function<E,​IFuture<R>> function,
                                            java.lang.Class<?> futuretype)
        Implements async loop and applies a an async function to each element.
        Parameters:
        function - The function.
        Returns:
        True result intermediate future.
      • flatMapAsync

        <R> IIntermediateFuture<R> flatMapAsync​(Function<E,​IIntermediateFuture<R>> function)
        Implements async loop and applies a an async multi-function to each element.
        Parameters:
        function - The function.
        Returns:
        True result intermediate future.