org.apache.spark

FutureAction

trait FutureAction[T] extends Future[T]

A future for the result of an action to support cancellation. This is an extension of the Scala Future interface to support cancellation.

Linear Supertypes
Future[T], Awaitable[T], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FutureAction
  2. Future
  3. Awaitable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cancel(): Unit

    Cancels the execution of this action.

  2. abstract def isCancelled: Boolean

    Returns whether the action has been cancelled.

  3. abstract def isCompleted: Boolean

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

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

    Definition Classes
    FutureAction → Future
  4. abstract def jobIds: Seq[Int]

    Returns the job IDs run by the underlying async operation.

    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.

  5. abstract def onComplete[U](func: (Try[T]) ⇒ U)(implicit executor: ExecutionContext): Unit

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

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

    Definition Classes
    FutureAction → Future
  6. abstract def ready(atMost: Duration)(implicit permit: CanAwait): FutureAction.this.type

    Blocks until this action completes.

    Blocks until this action completes.

    atMost

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

    returns

    this FutureAction

    Definition Classes
    FutureAction → Awaitable
  7. abstract def result(atMost: Duration)(implicit permit: CanAwait): T

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

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

    atMost

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

    returns

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

    Definition Classes
    FutureAction → Awaitable
    Annotations
    @throws( classOf[Exception] )
    Exceptions thrown
    Exception

    exception during action execution

  8. abstract def value: Option[Try[T]]

    The value of this Future.

    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.

    Definition Classes
    FutureAction → Future

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def andThen[U](pf: PartialFunction[Try[T], U])(implicit executor: ExecutionContext): Future[T]

    Definition Classes
    Future
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def collect[S](pf: PartialFunction[T, S])(implicit executor: ExecutionContext): Future[S]

    Definition Classes
    Future
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def failed: Future[Throwable]

    Definition Classes
    Future
  13. def fallbackTo[U >: T](that: Future[U]): Future[U]

    Definition Classes
    Future
  14. def filter(pred: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]

    Definition Classes
    Future
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def flatMap[S](f: (T) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]

    Definition Classes
    Future
  17. def foreach[U](f: (T) ⇒ U)(implicit executor: ExecutionContext): Unit

    Definition Classes
    Future
  18. def get(): T

    Blocks and returns the result of this job.

    Blocks and returns the result of this job.

    Annotations
    @throws( classOf[Exception] )
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. def map[S](f: (T) ⇒ S)(implicit executor: ExecutionContext): Future[S]

    Definition Classes
    Future
  23. def mapTo[S](implicit tag: ClassTag[S]): Future[S]

    Definition Classes
    Future
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def onFailure[U](callback: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Unit

    Definition Classes
    Future
  28. def onSuccess[U](pf: PartialFunction[T, U])(implicit executor: ExecutionContext): Unit

    Definition Classes
    Future
  29. def recover[U >: T](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Future[U]

    Definition Classes
    Future
  30. def recoverWith[U >: T](pf: PartialFunction[Throwable, Future[U]])(implicit executor: ExecutionContext): Future[U]

    Definition Classes
    Future
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. def transform[S](s: (T) ⇒ S, f: (Throwable) ⇒ Throwable)(implicit executor: ExecutionContext): Future[S]

    Definition Classes
    Future
  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def withFilter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]

    Definition Classes
    Future
  38. def zip[U](that: Future[U]): Future[(T, U)]

    Definition Classes
    Future

Inherited from Future[T]

Inherited from Awaitable[T]

Inherited from AnyRef

Inherited from Any

Ungrouped