com.twitter.util

FutureTask

class FutureTask [A] extends Promise[A] with Runnable

go to: companion
linear super types: Runnable, Promise[A], Future[A], TryLike[A, Future], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. FutureTask
  2. Runnable
  3. Promise
  4. Future
  5. TryLike
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new FutureTask (fn: ⇒ A)

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def addEventListener [U >: A] (listener: FutureEventListener[U]) : Unit

    definition classes: Future
  9. def andThen [R2] (f: (A) ⇒ Future[R2]) : Future[R2]

    Returns the given function applied to the value from this Return or returns this if this is a Throw.

    Returns the given function applied to the value from this Return or returns this if this is a Throw. Alias for flatMap

    definition classes: TryLike
  10. def apply (timeout: Duration) : A

    Block, but only as long as the given Timeout.

    Block, but only as long as the given Timeout.

    definition classes: Future
  11. def apply () : A

    Block indefinitely, wait for the result of the Future to be available.

    Block indefinitely, wait for the result of the Future to be available.

    definition classes: FutureTryLike
  12. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  13. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  14. def ensure (f: ⇒ Unit) : Future[A]

    Invoked regardless of whether the computation completed successfully or unsuccessfully.

    Invoked regardless of whether the computation completed successfully or unsuccessfully. Implemented in terms of respond so that subclasses control evaluation order. Returns this.

    definition classes: TryLike
  15. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def filter (p: (A) ⇒ Boolean) : Promise[A]

    Converts this to a Throw if the predicate does not obtain.

    Converts this to a Throw if the predicate does not obtain.

    definition classes: PromiseTryLike
  18. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  19. def flatMap [B, AlsoFuture[B] >: Future[B] <: Future[B]] (f: (A) ⇒ AlsoFuture[B]) : Promise[B]

    Returns the given function applied to the value from this Return or returns this if this is a Throw.

    Returns the given function applied to the value from this Return or returns this if this is a Throw.

    Note The gnarly type parameterization is there for Java compatibility, since Java does not support higher-kinded types.

    definition classes: PromiseTryLike
  20. def foreach (k: (A) ⇒ Unit) : Unit

    Invoke the callback only if the Future returns sucessfully.

    Invoke the callback only if the Future returns sucessfully. Useful for Scala for comprehensions. Use onSuccess instead of this method for more readable code.

    definition classes: FutureTryLike
  21. def get (timeout: Duration) : Try[A]

    Demands that the result of the future be available within timeout.

    Demands that the result of the future be available within timeout. The result is a Return[_] or Throw[_] depending upon whether the computation finished in time.

    definition classes: Future
  22. def get () : A

    Returns the value from this Return or throws the exception if this is a Throw.

    Returns the value from this Return or throws the exception if this is a Throw. Alias for apply()

    definition classes: TryLike
  23. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  24. def getOrElse [R2 >: R] (default: ⇒ R2) : R2

    Returns the value from this Return or the given argument if this is a Throw.

    Returns the value from this Return or the given argument if this is a Throw.

    definition classes: TryLike
  25. def handle [B >: A] (rescueException: PartialFunction[Throwable, B]) : Promise[B]

    Calls the exceptionHandler with the exception if this is a Throw.

    Calls the exceptionHandler with the exception if this is a Throw. This is like map for the exception.

    definition classes: PromiseTryLike
  26. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  27. def isDefined : Boolean

    Is the result of the Future available yet?

    Is the result of the Future available yet?

    definition classes: PromiseFuture
  28. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  29. def isReturn : Boolean

    Returns true if the Try is a Return, false otherwise.

    Returns true if the Try is a Return, false otherwise.

    definition classes: FutureTryLike
  30. def isThrow : Boolean

    Returns true if the Try is a Throw, false otherwise.

    Returns true if the Try is a Throw, false otherwise.

    definition classes: FutureTryLike
  31. def join [B] (other: Future[B]) : Future[(A, B)]

    Combines two Futures into one Future of the Tuple of the two results.

    Combines two Futures into one Future of the Tuple of the two results.

    definition classes: Future
  32. def map [B] (f: (A) ⇒ B) : Promise[B]

    Maps the given function to the value from this Return or returns this if this is a Throw

    Maps the given function to the value from this Return or returns this if this is a Throw

    definition classes: PromiseTryLike
  33. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  34. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  35. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  36. def onFailure (rescueException: (Throwable) ⇒ Unit) : Future[A]

    Invoke the funciton on the error, if the computation was unsuccessful.

    Invoke the funciton on the error, if the computation was unsuccessful. Returnsthis to allow for a fluent API. This function is like foreach but for the error case. It also differs from foreach in that it returns this. See rescue and handle for a less imperative API.

    returns

    this

    definition classes: FutureTryLike
  37. def onSuccess (f: (A) ⇒ Unit) : Future[A]

    Invoke the function on the result, if the computation was successful.

    Invoke the function on the result, if the computation was successful. Returnsthis to allow for a fluent API. This function is like foreach but it returnsthis. See map and flatMap for a less imperative API.

    returns

    this

    definition classes: FutureTryLike
  38. def or [U >: A] (other: Future[U]) : Future[U]

    A synonym for select(): Choose the first Future to succeed.

    A synonym for select(): Choose the first Future to succeed.

    definition classes: Future
  39. def proxyTo [B >: A] (other: Promise[B]) : Unit

    Send updates from this Future to the other.

    Send updates from this Future to the other.

    definition classes: Future
  40. def rescue [B >: A, AlsoFuture[B] >: Future[B] <: Future[B]] (rescueException: PartialFunction[Throwable, AlsoFuture[B]]) : Promise[B]

    Calls the exceptionHandler with the exception if this is a Throw.

    Calls the exceptionHandler with the exception if this is a Throw. This is like flatMap for the exception.

    Note The gnarly type parameterization is there for Java compatibility, since Java does not support higher-kinded types.

    definition classes: PromiseTryLike
  41. def respond (k: (Try[A]) ⇒ Unit) : Unit

    When the computation completes, invoke the given callback function.

    When the computation completes, invoke the given callback function. Respond() yields a Try (either a Return or a Throw). This method is most useful for very generic code (like libraries). Otherwise, it is a best practice to use one of the alternatives (onSuccess(), onFailure(), etc.). Note that almost all methods on Future[_] are written in terms of respond(), so this is the essential template method for use in concrete subclasses.

    Note: respond *should* enforce strong ordering. That is, calling respond(k) then respond(j) should guarantee that when the computation completes, k is called before j.

    definition classes: PromiseFutureTryLike
  42. def run () : Unit

    definition classes: FutureTask → Runnable
  43. def select [U >: A] (other: Future[U]) : Future[U]

    Choose the first Future to succeed.

    Choose the first Future to succeed.

    other

    another Future

    returns

    a new Future whose result is that of the first of this and other to return

    definition classes: Future
  44. def setException (throwable: Throwable) : Unit

    Populate the Promise with the given exception.

    Populate the Promise with the given exception.

    definition classes: Promise
  45. def setValue (result: A) : Unit

    Populate the Promise with the given result.

    Populate the Promise with the given result.

    definition classes: Promise
  46. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  47. def toOption : Option[A]

    Returns None if this is a Throw or a Some containing the value if this is a Return

    Returns None if this is a Throw or a Some containing the value if this is a Return

    definition classes: TryLike
  48. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  49. def unit : Future[Unit]

    Convert this Future[A] to a Future[Unit] by discarding the result.

    Convert this Future[A] to a Future[Unit] by discarding the result.

    definition classes: Future
  50. def update (result: Try[A]) : Unit

    Populate the Promise with the given Try.

    Populate the Promise with the given Try. The try can either be a value or an exception. setValue and setException are generally more readable methods to use.

    definition classes: Promise
  51. def updateIfEmpty (newResult: Try[A]) : Boolean

    Populate the Promise with the given Try.

    Populate the Promise with the given Try. The try can either be a value or an exception. setValue and setException are generally more readable methods to use.

    returns

    true or false depending on whether the result was available.

    definition classes: Promise
  52. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  53. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  54. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  55. def within (timer: Timer, timeout: Duration) : Future[A]

    Returns a new Future that will error if this Future does not return in time.

    Returns a new Future that will error if this Future does not return in time.

    timeout

    indicates how long you are willing to wait for the result to be available.

    definition classes: Future
  56. def within (timeout: Duration)(implicit timer: Timer) : Future[A]

    Same as the other within, but with an implict timer.

    Same as the other within, but with an implict timer. Sometimes this is more convenient.

    definition classes: Future

Inherited from Runnable

Inherited from Promise[A]

Inherited from Future[A]

Inherited from TryLike[A, Future]

Inherited from AnyRef

Inherited from Any