Promise

Abstract Value Members

abstract def future: Future[T]

Future containing the value of this promise.
abstract def isCompleted: Boolean

Returns whether the promise has already been completed with a value or an exception.
Returns whether the promise has already been completed with a value or an exception.
Note: Using this method may result in non-deterministic concurrent programs.
returns
true if the promise is already completed, false otherwise
abstract def tryComplete(result: Try[T]): Boolean

Tries to complete the promise with either a value or the exception.
Tries to complete the promise with either a value or the exception.
Note: Using this method may result in non-deterministic concurrent programs.
returns
If the promise has already been completed returns false, or true otherwise.

Concrete Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Definition Classes
AnyRef → Any
final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null.
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.
returns
a hash value consistent with ==

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Promise[T] to any2stringadd[Promise[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Promise[T], B)

Implicit information
This member is added by an implicit conversion from Promise[T] to ArrowAssoc[Promise[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
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
final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.
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 expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(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 type.
returns
the receiver object.

Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver object is not an instance of the erasure of type T0.
def clone(): AnyRef

Create a copy of the receiver object.
Create 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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
def complete(result: Try[T]): Promise.this.type

Completes the promise with either an exception or a value.
Completes the promise with either an exception or a value.
result
Either the value or the exception to complete the promise with.
If the promise has already been fulfilled, failed or has timed out, calling this method will throw an IllegalStateException.
final def completeWith(other: Future[T]): Promise.this.type

Completes this promise with the specified future, once that future is completed.
Completes this promise with the specified future, once that future is completed.
returns
This promise
def ensuring(cond: (Promise[T]) ⇒ Boolean, msg: ⇒ Any): Promise[T]

Implicit information
This member is added by an implicit conversion from Promise[T] to Ensuring[Promise[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Promise[T]) ⇒ Boolean): Promise[T]

Implicit information
This member is added by an implicit conversion from Promise[T] to Ensuring[Promise[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Promise[T]

Implicit information
This member is added by an implicit conversion from Promise[T] to Ensuring[Promise[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Promise[T]

Implicit information
This member is added by an implicit conversion from Promise[T] to Ensuring[Promise[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) 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).
returns
true if the argument is a reference to the receiver object; false otherwise.

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

The equality method for reference types.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def failure(cause: Throwable): Promise.this.type

Completes the promise with an exception.
Completes the promise with an exception.
cause
The throwable to complete the promise with.
If the throwable used to fail this promise is an error, a control exception or an interrupted exception, it will be wrapped as a cause within an ExecutionException which will fail the promise.
If the promise has already been fulfilled, failed or has timed out, calling this method will throw an IllegalStateException.
def finalize(): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
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.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
def formatted(fmtstr: String): String

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

Implicit information
This member is added by an implicit conversion from Promise[T] to StringFormat[Promise[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

A representation that corresponds to the dynamic class of the receiver object.
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.

Definition Classes
AnyRef → Any
Note
not specified by SLS as a member of AnyRef
def hashCode(): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.

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

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Definition Classes
AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
def success(value: T): Promise.this.type

Completes the promise with a value.
Completes the promise with a value.
value
The value to complete the promise with.
If the promise has already been fulfilled, failed or has timed out, calling this method will throw an IllegalStateException.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Creates a String representation of this object.
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.
returns
a String representation of the object.

Definition Classes
AnyRef → Any
final def tryCompleteWith(other: Future[T]): Promise.this.type

Attempts to complete this promise with the specified future, once that future is completed.
Attempts to complete this promise with the specified future, once that future is completed.
returns
This promise
def tryFailure(cause: Throwable): Boolean

Tries to complete the promise with an exception.
Tries to complete the promise with an exception.
Note: Using this method may result in non-deterministic concurrent programs.
returns
If the promise has already been completed returns false, or true otherwise.
def trySuccess(value: T): Boolean

Tries to complete the promise with a value.
Tries to complete the promise with a value.
Note: Using this method may result in non-deterministic concurrent programs.
returns
If the promise has already been completed returns false, or true otherwise.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Promise[T], B)

Implicit information
This member is added by an implicit conversion from Promise[T] to ArrowAssoc[Promise[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Promise[T] to any2stringadd[Promise[T]]

Inherited by implicit conversion StringFormat from Promise[T] to StringFormat[Promise[T]]

Inherited by implicit conversion Ensuring from Promise[T] to Ensuring[Promise[T]]

Inherited by implicit conversion ArrowAssoc from Promise[T] to ArrowAssoc[Promise[T]]

Ungrouped

Related Docs: object Promise | package concurrent

trait Promise[T] extends AnyRef

Abstract Value Members

abstract def future: Future[T]

abstract def isCompleted: Boolean

abstract def tryComplete(result: Try[T]): Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Promise[T], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def complete(result: Try[T]): Promise.this.type

final def completeWith(other: Future[T]): Promise.this.type

def ensuring(cond: (Promise[T]) ⇒ Boolean, msg: ⇒ Any): Promise[T]

def ensuring(cond: (Promise[T]) ⇒ Boolean): Promise[T]

def ensuring(cond: Boolean, msg: ⇒ Any): Promise[T]

def ensuring(cond: Boolean): Promise[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def failure(cause: Throwable): Promise.this.type

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def success(value: T): Promise.this.type

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def tryCompleteWith(other: Future[T]): Promise.this.type

def tryFailure(cause: Throwable): Boolean

def trySuccess(value: T): Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Promise[T], B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Promise[T] to any2stringadd[Promise[T]]

Inherited by implicit conversion StringFormat from Promise[T] to StringFormat[Promise[T]]

Inherited by implicit conversion Ensuring from Promise[T] to Ensuring[Promise[T]]

Inherited by implicit conversion ArrowAssoc from Promise[T] to ArrowAssoc[Promise[T]]

Ungrouped