com.codepoetics.fluvius.api.FlowExecution Maven / Gradle / Ivy

Go to download
package com.codepoetics.fluvius.api;

import com.codepoetics.fluvius.api.scratchpad.KeyValue;
import com.codepoetics.fluvius.api.scratchpad.Scratchpad;

import java.util.UUID;

/**
 * A {@link com.codepoetics.fluvius.api.Flow} compiled for execution.
 * @param  The type of the value returned by executing the compiled flow.
 */
public interface FlowExecution {

  /**
   * Run the compiled {@link com.codepoetics.fluvius.api.Flow} against the provided initial scratchpad, assigning the flow a randomly-generated UUID.
   *
   * @param initialScratchpad The initial scratchpad to run the flow against.
   * @return The result of running the flow.
   */
  T run(Scratchpad initialScratchpad) throws Exception;

  /**
   * Run the compiled {@link com.codepoetics.fluvius.api.Flow} against the provided initial scratchpad.
   *
   * @param flowId The id to assign to the flow.
   * @param initialScratchpad The initial scratchpad to run the flow against.
   * @return The result of running the flow.
   */
  T run(UUID flowId, Scratchpad initialScratchpad) throws Exception;

  /**
   * Run the compiled {@link com.codepoetics.fluvius.api.Flow} against an initial scratchpad created with the provided values, assigning the flow a randomly-generated UUID.
   *
   * @param initialKeyValues The initial key values to write into the scratchpad.
   * @return The result of running the flow.
   */
  T run(KeyValue... initialKeyValues) throws Exception;

  /**
   * Run the compiled {@link com.codepoetics.fluvius.api.Flow} against an initial scratchpad created with the provided values.
   *
   * @param flowId The id to assign to the flow.
   * @param initialKeyValues The initial key values to write into the scratchpad.
   * @return The result of running the flow.
   */
  T run(UUID flowId, KeyValue...initialKeyValues) throws Exception;

  /**
   * Create a {@link Runnable} that will execute this flow against the provided initial scratchpad, assigning the flow a randomly-generated UUID, and reporting results to the provided {@link FlowResultCallback}
   *
   * @param callback The callback to report results to.
   * @param initialScratchpad The initial scratchpad that the flow will be run against.
   * @return The constructed Runnable.
   */
  Runnable asAsync(FlowResultCallback callback, Scratchpad initialScratchpad);

  /**
   * Create a {@link Runnable} that will execute this flow against an initial scratchpad created with the provided values, assigning the flow a randomly-generated UUID, and reporting results to the provided {@link FlowResultCallback}
   *
   * @param callback The callback to report results to.
   * @param initialKeyValues The initial key values to write into the scratchpad.
   * @return The constructed Runnable.
   */
  Runnable asAsync(FlowResultCallback callback, KeyValue... initialKeyValues);

  /**
   * Create a {@link Runnable} that will execute this flow against the provided initial scratchpad, reporting results to the provided {@link FlowResultCallback}
   *
   * @param callback The callback to report results to.
   * @param initialScratchpad The initial scratchpad that the flow will be run against.
   * @return The constructed Runnable.
   */
  Runnable asAsync(UUID flowId, FlowResultCallback callback, Scratchpad initialScratchpad);

  /**
   * Create a {@link Runnable} that will execute this flow against an initial scratchpad created with the provided values, reporting results to the provided {@link FlowResultCallback}
   *
   * @param callback The callback to report results to.
   * @param initialKeyValues The initial key values to write into the scratchpad.
   * @return The constructed Runnable.
   */
  Runnable asAsync(UUID flowId, FlowResultCallback callback, KeyValue... initialKeyValues);

}