org.scalatest.concurrent

Eventually

object Eventually extends Eventually

Companion object that facilitates the importing of Eventually members as an alternative to mixing in the trait. One use case is to import Eventually's members so you can use them in the Scala interpreter:

$ scala -cp scalatest-1.8.jar
Welcome to Scala version 2.9.1.final (Java HotSpot(TM) 64-Bit Server VM, Java 1.6.0_29).
Type in expressions to have them evaluated.
Type :help for more information.
scala> import org.scalatest._
import org.scalatest._
scala> import matchers.ShouldMatchers._
import matchers.ShouldMatchers._
scala> import concurrent.Eventually._
import concurrent.Eventually._
scala> val xs = 1 to 125
xs: scala.collection.immutable.Range.Inclusive = Range(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ..., 125)
scala> val it = xs.iterator
it: Iterator[Int] = non-empty iterator
scala> eventually { it.next should be (3) }
scala> eventually { Thread.sleep(999); it.next should be (3) }
org.scalatest.TestFailedException: The code passed to eventually never returned normally.
    Attempted 2 times, sleeping 10 milliseconds between each attempt.
  at org.scalatest.Eventually$class.tryTryAgain$1(Eventually.scala:313)
  at org.scalatest.Eventually$class.eventually(Eventually.scala:322)
  ...

Linear Supertypes
Eventually, TimeoutConfiguration, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Eventually
  2. Eventually
  3. TimeoutConfiguration
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Type Members

  1. case class Interval (value: Span) extends TimeoutConfigParam with Product with Serializable

    A TimeoutConfigParam that specifies the amount of time to sleep after each retry: each unsuccessful invocation of the by-name parameter passed to eventually or each query of a future passed to whenReady.

  2. case class Timeout (value: Span) extends TimeoutConfigParam with Product with Serializable

    A TimeoutConfigParam that specifies the maximum amount of time to allow retries: either invocations of the by-name parameter passed to eventually that give an unsuccessful result, or futures passed to whenReady that are canceled, or expired, or not ready.

  3. case class TimeoutConfig (timeout: Span, interval: Span) extends Product with Serializable

    Configuration object for traits Eventually and Futures.

  4. class TimeoutConfigParam extends AnyRef

    Abstract class defining a family of configuration parameters for traits Eventually and Futures.

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def eventually [T] (fun: ⇒ T)(implicit config: TimeoutConfig): T

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    The by-name parameter "succeeds" if it returns a result. It "fails" if it throws any exception that would normally cause a test to fail. (These are any exceptions except TestPendingException and Errors listed in the Treatment of java.lang.Errors section of the documentation of trait Suite.)

    The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up is configured by the timeout field of the TimeoutConfig passed implicitly as the last parameter. The interval to sleep between attempts is configured by the interval field of the TimeoutConfig passed implicitly as the last parameter.

    fun

    the by-name parameter to repeatedly invoke

    config

    the TimeoutConfig object containing the timeout and interval parameters

    returns

    the result of invoking the fun by-name parameter, the first time it succeeds

    Definition Classes
    Eventually

  11. def eventually [T] (interval: Interval)(fun: ⇒ T)(implicit config: TimeoutConfig): T

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    The by-name parameter "succeeds" if it returns a result. It "fails" if it throws any exception that would normally cause a test to fail. (These are any exceptions except TestPendingException and Errors listed in the Treatment of java.lang.Errors section of the documentation of trait Suite.)

    The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up is configured by the timeout field of the TimeoutConfig passed implicitly as the last parameter. The interval to sleep between attempts is configured by the value contained in the passed interval parameter.

    interval

    the Interval configuration parameter

    fun

    the by-name parameter to repeatedly invoke

    config

    the TimeoutConfig object containing the (used) timeout and (unused) interval parameters

    returns

    the result of invoking the fun by-name parameter, the first time it succeeds

    Definition Classes
    Eventually

  12. def eventually [T] (timeout: Timeout)(fun: ⇒ T)(implicit config: TimeoutConfig): T

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    The by-name parameter "succeeds" if it returns a result. It "fails" if it throws any exception that would normally cause a test to fail. (These are any exceptions except TestPendingException and Errors listed in the Treatment of java.lang.Errors section of the documentation of trait Suite.)

    The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up and throwing TestFailedException is configured by the value contained in the passed timeout parameter. The interval to sleep between attempts is configured by the interval field of the TimeoutConfig passed implicitly as the last parameter.

    timeout

    the Timeout configuration parameter

    fun

    the by-name parameter to repeatedly invoke

    config

    the TimeoutConfig object containing the (unused) timeout and (used) interval parameters

    returns

    the result of invoking the fun by-name parameter, the first time it succeeds

    Definition Classes
    Eventually

  13. def eventually [T] (timeout: Timeout, interval: Interval)(fun: ⇒ T): T

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    Invokes the passed by-name parameter repeatedly until it either succeeds, or a configured maximum amount of time has passed, sleeping a configured interval between attempts.

    The by-name parameter "succeeds" if it returns a result. It "fails" if it throws any exception that would normally cause a test to fail. (These are any exceptions except TestPendingException and Errors listed in the Treatment of java.lang.Errors section of the documentation of trait Suite.)

    The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up and throwing TestFailedException is configured by the value contained in the passed timeout parameter. The interval to sleep between attempts is configured by the value contained in the passed interval parameter.

    timeout

    the Timeout configuration parameter

    interval

    the Interval configuration parameter

    fun

    the by-name parameter to repeatedly invoke

    returns

    the result of invoking the fun by-name parameter, the first time it succeeds

    Definition Classes
    Eventually

  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef

  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  17. def interval (value: Span): Interval

    Returns an Interval configuration parameter containing the passed value, which specifies the amount of time to sleep after each retry: each unsuccessful invocation of the by-name parameter passed to eventually or each query of a non-ready, canceled, or expired future passed to whenReady.

    Returns an Interval configuration parameter containing the passed value, which specifies the amount of time to sleep after each retry: each unsuccessful invocation of the by-name parameter passed to eventually or each query of a non-ready, canceled, or expired future passed to whenReady.

    Definition Classes
    TimeoutConfiguration

  18. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  19. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  20. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  21. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  22. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  23. def timeout (value: Span): Timeout

    Returns a Timeout configuration parameter containing the passed value, which specifies the maximum amount of time to retry: to allow invocations of the by-name parameter passed to eventually to give an unsuccessful result, or to allow a future passed to whenReady to be canceled, or expired, or not ready.

    Returns a Timeout configuration parameter containing the passed value, which specifies the maximum amount of time to retry: to allow invocations of the by-name parameter passed to eventually to give an unsuccessful result, or to allow a future passed to whenReady to be canceled, or expired, or not ready.

    Definition Classes
    TimeoutConfiguration

  24. implicit val timeoutConfig : TimeoutConfig

    Implicit TimeoutConfig value providing default configuration values.

    Implicit TimeoutConfig value providing default configuration values.

    To change the default configuration, override or hide this val with another implicit TimeoutConfig containing your desired default configuration values.

    Attributes
    implicit
    Definition Classes
    TimeoutConfiguration

  25. def toString (): String

    Definition Classes
    AnyRef → Any

  26. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  27. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  28. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Eventually

Inherited from TimeoutConfiguration

Inherited from AnyRef

Inherited from Any