Trait

org.scalatest.concurrent.Futures

FutureConcept

Related Doc: package Futures

Permalink

trait FutureConcept[T] extends AnyRef

Concept trait for futures, instances of which are passed to the whenReady methods of trait Futures.

See the documentation for trait Futures for the details on the syntax this trait provides for testing with futures.

Self Type
FutureConcept[T]
Source
Futures.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FutureConcept
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def eitherValue: Option[Either[Throwable, T]]

    Permalink

    Queries this future for its value.

    Queries this future for its value.

    If the future is not ready, this method will return None. If ready, it will either return an exception or a T.

  2. abstract def isCanceled: Boolean

    Permalink

    Indicates whether this future has been canceled.

    Indicates whether this future has been canceled.

    If the underlying future does not support the concept of cancellation, this method must always return false.

  3. abstract def isExpired: Boolean

    Permalink

    Indicates whether this future has expired (timed out).

    Indicates whether this future has expired (timed out).

    The timeout detected by this method is different from the timeout supported by whenReady. This timeout is a timeout of the underlying future. If the underlying future does not support timeouts, this method must always return false.

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def futureValue(implicit config: Futures.PatienceConfig, pos: Position): T

    Permalink

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., futureValue returned a Left) or TestFailedException.

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., futureValue returned a Left) or TestFailedException.

    This trait's implementation of this method queries the future repeatedly until it either is ready, or a configured maximum amount of time has passed, sleeping a configured interval between attempts; and when ready, returns the future's value. For greater efficiency, implementations of this trait may override this method so that it blocks the specified timeout while waiting for the result, if the underlying future supports this.

    The maximum amount of time to wait for the future to become ready before giving up and throwing TestFailedException is configured by the timeout field of the PatienceConfig passed implicitly as the last parameter. The interval to sleep between queries of the future (used only if the future is polled) is configured by the interval field of the PatienceConfig passed implicitly as the last parameter.

    If the eitherValue method of the underlying Scala future returns a scala.Some containing a scala.util.Failure containing a java.util.concurrent.ExecutionException, and this exception contains a non-null cause, that cause will be included in the TestFailedException as its cause. The ExecutionException will be be included as the TestFailedException's cause only if the ExecutionException's cause is null.

    config

    a PatienceConfig object containing timeout and interval parameters that are unused by this method

    returns

    the result of the future once it is ready, if value is defined as a Right

    Exceptions thrown

    TestFailedException if the future is cancelled, expires, or is still not ready after the specified timeout has been exceeded

    Throwable if once ready, the value of this future is defined as a Left (in this case, this method throws that same exception)

  10. final def futureValue(interval: Interval)(implicit config: Futures.PatienceConfig, pos: Position): T

    Permalink

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., eitherValue returned a Left) or TestFailedException.

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., eitherValue returned a Left) or TestFailedException.

    The maximum amount of time to wait for the future to become ready before giving up and throwing TestFailedException is configured by the timeout field of the PatienceConfig passed implicitly as the last parameter. The interval to sleep between queries of the future (used only if the future is polled) is configured by the value contained in the passed interval parameter.

    This method invokes the overloaded futureValue form with only one (implicit) argument list that contains only one argument, a PatienceConfig, passing a new PatienceConfig with the Interval specified as interval and the Timeout specified as config.timeout.

    If the eitherValue method of the underlying Scala future returns a scala.Some containing a scala.util.Failure containing a java.util.concurrent.ExecutionException, and this exception contains a non-null cause, that cause will be included in the TestFailedException as its cause. The ExecutionException will be be included as the TestFailedException's cause only if the ExecutionException's cause is null.

    interval

    the Interval configuration parameter

    config

    an PatienceConfig object containing timeout and interval parameters that are unused by this method

    returns

    the result of the future once it is ready, if value is defined as a Right

    Exceptions thrown

    TestFailedException if the future is cancelled, expires, or is still not ready after the specified timeout has been exceeded

    Throwable if once ready, the value of this future is defined as a Left (in this case, this method throws that same exception)

  11. final def futureValue(timeout: Timeout)(implicit config: Futures.PatienceConfig, pos: Position): T

    Permalink

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., value returned a Left) or TestFailedException.

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., value returned a Left) or TestFailedException.

    The maximum amount of time to wait for the future to become ready before giving up and throwing TestFailedException is configured by the value contained in the passed timeout parameter. The interval to sleep between queries of the future (used only if the future is polled) is configured by the interval field of the PatienceConfig passed implicitly as the last parameter.

    This method invokes the overloaded futureValue form with only one (implicit) argument list that contains only one argument, a PatienceConfig, passing a new PatienceConfig with the Timeout specified as timeout and the Interval specified as config.interval.

    If the eitherValue method of the underlying Scala future returns a scala.Some containing a scala.util.Failure containing a java.util.concurrent.ExecutionException, and this exception contains a non-null cause, that cause will be included in the TestFailedException as its cause. The ExecutionException will be be included as the TestFailedException's cause only if the ExecutionException's cause is null.

    timeout

    the Timeout configuration parameter

    config

    an PatienceConfig object containing timeout and interval parameters that are unused by this method

    returns

    the result of the future once it is ready, if eitherValue is defined as a Right

    Exceptions thrown

    TestFailedException if the future is cancelled, expires, or is still not ready after the specified timeout has been exceeded

    Throwable if once ready, the eitherValue of this future is defined as a Left (in this case, this method throws that same exception)

  12. final def futureValue(timeout: Timeout, interval: Interval)(implicit pos: Position): T

    Permalink

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., value returned a Left) or TestFailedException.

    Returns the result of this FutureConcept, once it is ready, or throws either the exception returned by the future (i.e., value returned a Left) or TestFailedException.

    The maximum amount of time to wait for the future to become ready before giving up and throwing TestFailedException is configured by the value contained in the passed timeout parameter. The interval to sleep between queries of the future (used only if the future is polled) is configured by the value contained in the passed interval parameter.

    This method invokes the overloaded futureValue form with only one (implicit) argument list that contains only one argument, a PatienceConfig, passing a new PatienceConfig with the Timeout specified as timeout and the Interval specified as interval.

    If the eitherValue method of the underlying Scala future returns a scala.Some containing a scala.util.Failure containing a java.util.concurrent.ExecutionException, and this exception contains a non-null cause, that cause will be included in the TestFailedException as its cause. The ExecutionException will be be included as the TestFailedException's cause only if the ExecutionException's cause is null.

    timeout

    the Timeout configuration parameter

    interval

    the Interval configuration parameter

    returns

    the result of the future once it is ready, if value is defined as a Right

    Exceptions thrown

    TestFailedException if the future is cancelled, expires, or is still not ready after the specified timeout has been exceeded

    Throwable if once ready, the value of this future is defined as a Left (in this case, this method throws that same exception)

  13. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  16. final def isReadyWithin(timeout: Span)(implicit config: Futures.PatienceConfig, pos: Position): Boolean

    Permalink

    Indicates whether this future is ready within the specified timeout.

    Indicates whether this future is ready within the specified timeout.

    If the eitherValue method of the underlying Scala future returns a scala.Some containing a scala.util.Failure containing a java.util.concurrent.ExecutionException, and this exception contains a non-null cause, that cause will be included in the TestFailedException as its cause. The ExecutionException will be be included as the TestFailedException's cause only if the ExecutionException's cause is null.

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped