All Implemented Interfaces:

FutureAction<T>, scala.concurrent.Awaitable<T>, scala.concurrent.Future<T>

public class SimpleFutureAction<T> extends Object implements FutureAction<T>

A FutureAction holding the result of an action that triggers a single job. Examples include count, collect, reduce.

• Nested Class Summary

  Nested classes/interfaces inherited from interface scala.concurrent.Future

  scala.concurrent.Future.never$

• Method Summary

  void

  cancel(scala.Option<String> reason)

  Cancels the execution of this action with an optional reason.

  boolean

  Returns whether the action has been cancelled.

  boolean

  Returns whether the action has already been completed with a value or an exception.

  scala.collection.immutable.Seq<Object>

  jobIds()

  Returns the job IDs run by the underlying async operation.

  <U> void

  onComplete(scala.Function1<scala.util.Try<T>,U> func, scala.concurrent.ExecutionContext executor)

  When this action is completed, either through an exception, or a value, applies the provided function.

  ready(scala.concurrent.duration.Duration atMost, scala.concurrent.CanAwait permit)

  Blocks until this action completes.

  result(scala.concurrent.duration.Duration atMost, scala.concurrent.CanAwait permit)

  Awaits and returns the result (of type T) of this action.

  <S> scala.concurrent.Future<S>

  transform(scala.Function1<scala.util.Try<T>,scala.util.Try<S>> f, scala.concurrent.ExecutionContext e)

  <S> scala.concurrent.Future<S>

  transformWith(scala.Function1<scala.util.Try<T>,scala.concurrent.Future<S>> f, scala.concurrent.ExecutionContext e)

  scala.Option<scala.util.Try<T>>

  value()

  The value of this Future.

  Methods inherited from interface scala.concurrent.Future

  andThen, collect, failed, fallbackTo, filter, flatMap, flatten, foreach, map, mapTo, recover, recoverWith, transform, withFilter, zip, zipWith

• Method Details

  • cancel

    public void cancel(scala.Option<String> reason)

    Cancels the execution of this action with an optional reason.

    Specified by:

    cancel in interface FutureAction<T>

    Parameters:

    reason - (undocumented)

  • isCancelled

    public boolean isCancelled()

    Returns whether the action has been cancelled.

    Specified by:

    isCancelled in interface FutureAction<T>

    Returns:

    (undocumented)

  • isCompleted

    public boolean isCompleted()

    Returns whether the action has already been completed with a value or an exception.

    Specified by:

    isCompleted in interface scala.concurrent.Future<T>

    Specified by:

    isCompleted in interface FutureAction<T>

    Returns:

    (undocumented)

  • jobIds

    public scala.collection.immutable.Seq<Object> jobIds()

    Returns the job IDs run by the underlying async operation.

    This returns the current snapshot of the job list. Certain operations may run multiple jobs, so multiple calls to this method may return different lists.

    Specified by:

    jobIds in interface FutureAction<T>

    Returns:

    (undocumented)

  • onComplete

    public <U> void onComplete(scala.Function1<scala.util.Try<T>,U> func, scala.concurrent.ExecutionContext executor)

    When this action is completed, either through an exception, or a value, applies the provided function.

    Specified by:

    onComplete in interface scala.concurrent.Future<T>

    Specified by:

    onComplete in interface FutureAction<T>

    Parameters:

    func - (undocumented)

    executor - (undocumented)

  • ready

    public SimpleFutureAction<T> ready(scala.concurrent.duration.Duration atMost, scala.concurrent.CanAwait permit)

    Blocks until this action completes.

    Specified by:

    ready in interface scala.concurrent.Awaitable<T>

    Specified by:

    ready in interface FutureAction<T>

    Parameters:

    atMost - maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

    permit - (undocumented)

    Returns:

    this FutureAction

  • result

    public T result(scala.concurrent.duration.Duration atMost, scala.concurrent.CanAwait permit) throws Exception

    Awaits and returns the result (of type T) of this action.

    Specified by:

    result in interface scala.concurrent.Awaitable<T>

    Specified by:

    result in interface FutureAction<T>

    Parameters:

    atMost - maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

    permit - (undocumented)

    Returns:

    the result value if the action is completed within the specific maximum wait time

    Throws:

    Exception - exception during action execution

  • transform

    public <S> scala.concurrent.Future<S> transform(scala.Function1<scala.util.Try<T>,scala.util.Try<S>> f, scala.concurrent.ExecutionContext e)

    Specified by:

    transform in interface scala.concurrent.Future<T>

  • transformWith

    public <S> scala.concurrent.Future<S> transformWith(scala.Function1<scala.util.Try<T>,scala.concurrent.Future<S>> f, scala.concurrent.ExecutionContext e)

    Specified by:

    transformWith in interface scala.concurrent.Future<T>

  • value

    public scala.Option<scala.util.Try<T>> value()

    The value of this Future.

    If the future is not completed the returned value will be None. If the future is completed the value will be Some(Success(t)) if it contains a valid result, or Some(Failure(error)) if it contains an exception.

    Specified by:

    value in interface scala.concurrent.Future<T>

    Specified by:

    value in interface FutureAction<T>

    Returns:

    (undocumented)