Returns whether the future had already been completed with a value or an exception.

Note: using this method yields nondeterministic dataflow programs.

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

If the future has already been completed, this will either be applied immediately or be scheduled asynchronously.

Note that the returned value of f will be discarded.

Since this method executes asynchronously and does not produce a return value, any non-fatal exceptions thrown will be reported to the ExecutionContext.

Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

The provided callback always runs in the provided implicit ExecutionContext, though there is no guarantee that the execute() method on the ExecutionContext will be called once per callback or that execute() will be called in the current thread. That is, the implementation may run multiple callbacks in a batch within a single execute() and it may run execute() either immediately or asynchronously. Completion of the Future must *happen-before* the invocation of the callback.

Await the "completed" state of this Awaitable.

This method should not be called directly; use Await.ready instead.

Await and return the result (of type T) of this Awaitable.

This method should not be called directly; use Await.result instead.

Creates a new Future by applying the specified function to the result of this Future. If there is any non-fatal exception thrown when 'f' is applied then that exception will be propagated to the resulting future.

Creates a new Future by applying the specified function, which produces a Future, to the result of this Future. If there is any non-fatal exception thrown when 'f' is applied then that exception will be propagated to the resulting future.

The current value of this Future.

Note: using this method yields nondeterministic dataflow programs.

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

Test two objects for inequality.

Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

Applies the side-effecting function to the result of this future, and returns a new future with the result of this future.

This method allows one to enforce that the callbacks are executed in a specified order.

Note that if one of the chained andThen callbacks throws an exception, that exception is not propagated to the subsequent andThen callbacks. Instead, the subsequent andThen callbacks are given the original value of this future.

The following example prints out 5:

val f = Future { 5 }
f andThen {
  case r => throw new RuntimeException("runtime exception")
} andThen {
  case Failure(t) => println(t)
  case Success(v) => println(v)
}

Since this method executes asynchronously and does not produce a return value, any non-fatal exceptions thrown will be reported to the ExecutionContext.

Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

It is platform dependent whether asInstanceOf has any effect at runtime. It might do a runtime type test on the erasure of T0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

In particular, asInstanceOf is not a type test. It does **not** mean:

this match {
 case x: T0 => x
 case _     => throw ClassCastException("...")

Use pattern matching or isInstanceOf for type testing instead.

Situations where asInstanceOf is useful:

• when flow analysis fails to deduce T0 automatically
• when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

Be careful of using asInstanceOf when T0 is a primitive type. When T0 is primitive, asInstanceOf may insert a conversion instead of a type test. If your intent is to convert, use a toT method (x.toChar, x.toByte, etc.).

Create a copy of the receiver object.

The default implementation of the clone method is platform dependent.

Creates a new future by mapping the value of the current future, if the given partial function is defined at that value.

If the current future contains a value for which the partial function is defined, the new future will also hold that value. Otherwise, the resulting future will fail with a NoSuchElementException.

If the current future fails, then the resulting future also fails.

Example:

val f = Future { -5 }
val g = f collect {
  case x if x < 0 => -x
}
val h = f collect {
  case x if x > 0 => x * 2
}
g foreach println // Eventually prints 5
Await.result(h, Duration.Zero) // throw a NoSuchElementException

Tests whether the argument (that) is a reference to the receiver object (this).

The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional 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).

The equality method for reference types. Default implementation delegates to eq.

See also equals in scala.Any.

The returned Future will be successfully completed with the Throwable of the original Future if the original Future fails.

If the original Future is successful, the returned Future is failed with a NoSuchElementException.

This future may contain a throwable object and this means that the future failed. Futures obtained through combinators have the same exception as the future they were obtained from. The following throwable objects are not contained in the future:

• Error - fatal errors are not contained within futures
• InterruptedException - not contained within futures
• all scala.util.control.ControlThrowable except NonLocalReturnControl - not contained within futures

Instead, the future is completed with an ExecutionException that has one of the exceptions above as its cause. If a future is failed with a scala.runtime.NonLocalReturnControl, it is completed with a value from that throwable instead.

Creates a new future which holds the result of this future if it was completed successfully, or, if not, the result of the that future if that is completed successfully. If both futures are failed, the resulting future holds the throwable object of the first future.

Using this method will not cause concurrent programs to become nondeterministic.

Example:

val f = Future { throw new RuntimeException("failed") }
val g = Future { 5 }
val h = f fallbackTo g
h foreach println // Eventually prints 5

Creates a new future by filtering the value of the current future with a predicate.

If the current future contains a value which satisfies the predicate, the new future will also hold that value. Otherwise, the resulting future will fail with a NoSuchElementException.

If the current future fails, then the resulting future also fails.

Example:

val f = Future { 5 }
val g = f filter { _ % 2 == 1 }
val h = f filter { _ % 2 == 0 }
g foreach println // Eventually prints 5
Await.result(h, Duration.Zero) // throw a NoSuchElementException

Called by the garbage collector on the receiver object when there are no more references to the object.

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

Creates a new future by applying a function to the successful result of this future, and returns the result of the function as the new future. If this future is completed with an exception then the new future will also contain this exception.

Example:

val f = Future { 5 }
val g = Future { 3 }
val h = for {
  x: Int <- f // returns Future(5)
  y: Int <- g // returns Future(3)
} yield x + y

is translated to:

f flatMap { (x: Int) => g map { (y: Int) => x + y } }

Creates a new future with one level of nesting flattened, this method is equivalent to flatMap(identity).

Asynchronously processes the value in the future once the value becomes available.

WARNING: Will not be called if this future is never completed or if it is completed with a failure.

Since this method executes asynchronously and does not produce a return value, any non-fatal exceptions thrown will be reported to the ExecutionContext.

Returns the runtime class representation of the object.

The hashCode method for reference types. See hashCode in scala.Any.

Test whether the dynamic type of the receiver object has the same erasure as T0.

Depending on what T0 is, the test is done in one of the below ways:

• T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
• T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
• T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
• T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
• T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
• T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

This is exactly equivalent to the type pattern _: T0

Creates a new future by applying a function to the successful result of this future. If this future is completed with an exception then the new future will also contain this exception.

Example:

val f = Future { "The future" }
val g = f map { x: String => x + " is now!" }

Note that a for comprehension involving a Future may expand to include a call to map and or flatMap and withFilter. See scala.concurrent.Future#flatMap for an example of such a comprehension.

Creates a new Future[S] which is completed with this Future's result if that conforms to S's erased type or a ClassCastException otherwise.

Equivalent to !(this eq that).

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

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

Creates a new future that will handle any matching throwable that this future might contain. If there is no match, or if this future contains a valid result then the new future will contain the same.

Example:

Future (6 / 0) recover { case e: ArithmeticException => 0 } // result: 0
Future (6 / 0) recover { case e: NotFoundException   => 0 } // result: exception
Future (6 / 2) recover { case e: ArithmeticException => 0 } // result: 3

Creates a new future that will handle any matching throwable that this future might contain by assigning it a value of another future.

If there is no match, or if this future contains a valid result then the new future will contain the same result.

Example:

val f = Future { Int.MaxValue }
Future (6 / 0) recoverWith { case e: ArithmeticException => f } // result: Int.MaxValue

Executes the code in body with an exclusive lock on this.

Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

Creates a new future by applying the 's' function to the successful result of this future, or the 'f' function to the failed result. If there is any non-fatal exception thrown when 's' or 'f' is applied, that exception will be propagated to the resulting future.

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

Zips the values of this and that future, and creates a new future holding the tuple of their results.

If either input future fails, the resulting future is failed with the same throwable, without waiting for the other input future to complete.

If the application of f throws a non-fatal throwable, the resulting future is failed with that throwable.

Zips the values of this and that future using a function f, and creates a new future holding the result.

If either input future fails, the resulting future is failed with the same throwable, without waiting for the other input future to complete.

If the application of f throws a non-fatal throwable, the resulting future is failed with that throwable.

Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).