Package de.esoco.coroutine.step

Class CallSubroutine<I,​O>

  • All Implemented Interfaces:
    de.esoco.lib.property.Fluent<CoroutineStep<I,​O>>, org.obrel.core.FluentRelatable<CoroutineStep<I,​O>>, org.obrel.core.Relatable
    public class CallSubroutine<I,​O>
extends CoroutineStep<I,​O>
    A Coroutine step that executes another coroutine in the context of the parent routine.

    • Constructor Summary

      Constructors 
      Constructor Description
      CallSubroutine​(Coroutine<I,​O> coroutine)
      Creates a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static <I,​O>
      CallSubroutine<I,​O>      		 call​(Coroutine<I,​O> coroutine)
      Calls a coroutine as a subroutine of the coroutine this step is added to.
      protected O execute​(I input, Continuation<?> continuation)
      This method must be implemented by subclasses to provide the actual functionality of this step.
      void runAsync​(java.util.concurrent.CompletableFuture<I> previousExecution, CoroutineStep<O,​?> nextStep, Continuation<?> continuation)
      Runs this execution step asynchronously as a continuation of a previous code execution in a CompletableFuture and proceeds to the next step afterwards.

      • Methods inherited from class org.obrel.core.RelatedObject

        deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, transform, writeRelations

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface de.esoco.lib.property.Fluent

        _with

      • Methods inherited from interface org.obrel.core.FluentRelatable

        with, with, with

      • Methods inherited from interface org.obrel.core.Relatable

        deleteRelation, deleteRelation, deleteRelations, get, getAll, getOption, getRelation, getRelationCount, getRelations, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, set, set, setOption, streamRelations, transform

    • Constructor Detail

      • CallSubroutine

        public CallSubroutine​(Coroutine<I,​O> coroutine)
        Creates a new instance.
        Parameters:
        coroutine - The sub-coroutine

    • Method Detail

      • call

        public static <I,​O> CallSubroutine<I,​O> call​(Coroutine<I,​O> coroutine)
        Calls a coroutine as a subroutine of the coroutine this step is added to.
        Parameters:
        coroutine - The coroutine to invoke as a subroutine
        Returns:
        The new coroutine step

      • runAsync

        public void runAsync​(java.util.concurrent.CompletableFuture<I> previousExecution,
                     CoroutineStep<O,​?> nextStep,
                     Continuation<?> continuation)
        Runs this execution step asynchronously as a continuation of a previous code execution in a CompletableFuture and proceeds to the next step afterwards.

        Subclasses that need to suspend the invocation of the next step until some condition is met (e.g. sending or receiving data has finished) need to override this method and create a Suspension by invoking Continuation.suspend(CoroutineStep, CoroutineStep) on the next step. If the condition that caused the suspension resolves the coroutine execution can be resumed by calling Suspension.resume(Object).

        Subclasses that override this method also need to handle errors by terminating any further execution (i.e. not resuming a suspension if such exists) and forwarding the causing exception to Continuation.fail(Throwable).

        Overrides:
        runAsync in class CoroutineStep<I,​O>
        Parameters:
        previousExecution - The future of the previous code execution
        nextStep - The next step to execute or NULL for none
        continuation - The continuation of the execution

      • execute

        protected O execute​(I input,
                    Continuation<?> continuation)
        This method must be implemented by subclasses to provide the actual functionality of this step.
        Specified by:
        execute in class CoroutineStep<I,​O>
        Parameters:
        input - The input value
        continuation - The continuation of the execution
        Returns:
        The result of the execution