object ScalaFutures extends ScalaFutures
Companion object that facilitates the importing of ScalaFutures members as
an alternative to mixing in the trait. One use case is to import ScalaFutures's members so you can use
them in the Scala interpreter.
- Source
- ScalaFutures.scala
- Alphabetic
- By Inheritance
- ScalaFutures
- ScalaFutures
- Futures
- PatienceConfiguration
- AbstractPatienceConfiguration
- ScaledTimeSpans
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
-   final  case class PatienceConfig(timeout: Span = scaled(Span(150, Millis)), interval: Span = scaled(Span(15, Millis))) extends Product with SerializableConfiguration object for asynchronous constructs, such as those provided by traits EventuallyandWaiters.Configuration object for asynchronous constructs, such as those provided by traits EventuallyandWaiters.The default values for the parameters are: Configuration Parameter Default Value timeoutscaled(150 milliseconds)intervalscaled(15 milliseconds)- timeout
- the maximum amount of time to wait for an asynchronous operation to complete before giving up and throwing - TestFailedException.
- interval
- the amount of time to sleep between each check of the status of an asynchronous operation when polling 
 - Definition Classes
- AbstractPatienceConfiguration
 
-    trait FutureConcept[T] extends AnyRefConcept trait for futures, instances of which are passed to the whenReadymethods of traitFutures.
Value Members
-   final  def !=(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def ##: Int- Definition Classes
- AnyRef → Any
 
-   final  def ==(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def asInstanceOf[T0]: T0- Definition Classes
- Any
 
-    def clone(): AnyRef- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
 
-   implicit  def convertScalaFuture[T](scalaFuture: Future[T]): FutureConcept[T]Implicitly converts a scala.concurrent.Future[T]toFutureConcept[T], allowing you to invoke the methods defined onFutureConcepton a ScalaFuture, as well as to pass a Scala future to thewhenReadymethods of supertraitFutures.Implicitly converts a scala.concurrent.Future[T]toFutureConcept[T], allowing you to invoke the methods defined onFutureConcepton a ScalaFuture, as well as to pass a Scala future to thewhenReadymethods of supertraitFutures.See the documentation for supertrait Futuresfor the details on the syntax this trait provides for testing with Java futures.If the eitherValuemethod of the underlying Scala future returns ascala.Somecontaining ascala.util.Failurecontaining ajava.util.concurrent.ExecutionException, and this exception contains a non-nullcause, that cause will be included in theTestFailedExceptionas its cause. TheExecutionExceptionwill be be included as theTestFailedException's cause only if theExecutionException's cause isnull.The isExpiredmethod of the returnedFutureConceptwill always returnfalse, because the underlying type,scala.concurrent.Future, does not support the notion of expiration. Likewise, theisCanceledmethod of the returnedFutureConceptwill always returnfalse, because the underlying type,scala.concurrent.Future, does not support the notion of cancelation.- scalaFuture
- a - scala.concurrent.Future[T]to convert
- returns
- a - FutureConcept[T]wrapping the passed- scala.concurrent.Future[T]
 - Definition Classes
- ScalaFutures
 
-   final  def eq(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def equals(arg0: AnyRef): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
 
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
 
-    def interval(value: Span): IntervalReturns an Intervalconfiguration parameter containing the passed value, which specifies the amount of time to sleep after a retry.Returns an Intervalconfiguration parameter containing the passed value, which specifies the amount of time to sleep after a retry.- Definition Classes
- PatienceConfiguration
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-   final  def ne(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-   final  def notify(): Unit- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
 
-   final  def notifyAll(): Unit- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
 
-   implicit  def patienceConfig: PatienceConfigImplicit PatienceConfigvalue providing default configuration values.Implicit PatienceConfigvalue providing default configuration values.To change the default configuration, override or hide this defwith another implicitPatienceConfigcontaining your desired default configuration values.- Definition Classes
- PatienceConfiguration → AbstractPatienceConfiguration
 
-   final  def scaled(span: Span): SpanScales the passed Spanby theDoublefactor returned byspanScaleFactor.Scales the passed Spanby theDoublefactor returned byspanScaleFactor.The Spanis scaled by invoking itsscaledBymethod, thus this method has the same behavior: The value returned byspanScaleFactorcan be any positive number or zero, including a fractional number. A number greater than one will scale theSpanup to a larger value. A fractional number will scale it down to a smaller value. A factor of 1.0 will cause the exact sameSpanto be returned. A factor of zero will causeSpan.ZeroLengthto be returned. If overflow occurs,Span.Maxwill be returned. If underflow occurs,Span.ZeroLengthwill be returned.- Definition Classes
- ScaledTimeSpans
- Exceptions thrown
- IllegalArgumentExceptionif the value returned from- spanScaleFactoris less than zero
 
-    def spanScaleFactor: DoubleThe factor by which the scaledmethod will scaleSpans.The factor by which the scaledmethod will scaleSpans.The default implementation of this method will return the span scale factor that was specified for the run, or 1.0 if no factor was specified. For example, you can specify a span scale factor when invoking ScalaTest via the command line by passing a -Fargument toRunner.- Definition Classes
- ScaledTimeSpans
 
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    def timeout(value: Span): TimeoutReturns a Timeoutconfiguration parameter containing the passed value, which specifies the maximum amount to wait for an asynchronous operation to complete.Returns a Timeoutconfiguration parameter containing the passed value, which specifies the maximum amount to wait for an asynchronous operation to complete.- Definition Classes
- PatienceConfiguration
 
-    def toString(): String- Definition Classes
- AnyRef → Any
 
-   final  def wait(arg0: Long, arg1: Int): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   final  def wait(arg0: Long): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
 
-   final  def wait(): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   final  def whenReady[T, U](future: FutureConcept[T])(fun: (T) => U)(implicit config: PatienceConfig, pos: Position): UQueries the passed 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, passes the future's value to the passed function. Queries the passed 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, passes the future's value to the passed function. The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up is configured by the timeoutfield of thePatienceConfigpassed implicitly as the last parameter. The interval to sleep between attempts is configured by theintervalfield of thePatienceConfigpassed implicitly as the last parameter.If the eitherValuemethod of the underlying Scala future returns ascala.Somecontaining ascala.util.Failurecontaining ajava.util.concurrent.ExecutionException, and this exception contains a non-nullcause, that cause will be included in theTestFailedExceptionas its cause. TheExecutionExceptionwill be be included as theTestFailedException's cause only if theExecutionException's cause isnull.- future
- the future to query 
- fun
- the function to which pass the future's value when it is ready 
- config
- an - PatienceConfigobject containing- timeoutand- intervalparameters that are unused by this method
- returns
- the result of invoking the - funparameter
 - Definition Classes
- Futures
 
-   final  def whenReady[T, U](future: FutureConcept[T], interval: Interval)(fun: (T) => U)(implicit config: PatienceConfig, pos: Position): UQueries the passed 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, passes the future's value to the passed function. Queries the passed 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, passes the future's value to the passed function. The maximum amount of time in milliseconds to tolerate unsuccessful attempts before giving up is configured by the timeoutfield of thePatienceConfigpassed implicitly as the last parameter. The interval to sleep between attempts is configured by the value contained in the passedintervalparameter.- future
- the future to query 
- interval
- the - Intervalconfiguration parameter
- fun
- the function to which pass the future's value when it is ready 
- config
- an - PatienceConfigobject containing- timeoutand- intervalparameters that are unused by this method
- returns
- the result of invoking the - funparameter
 - Definition Classes
- Futures
 
-   final  def whenReady[T, U](future: FutureConcept[T], timeout: Timeout)(fun: (T) => U)(implicit config: PatienceConfig, pos: Position): UQueries the passed 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, passes the future's value to the passed function. Queries the passed 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, passes the future's value to the passed function. The maximum amount of time in milliseconds to tolerate unsuccessful queries before giving up and throwing TestFailedExceptionis configured by the value contained in the passedtimeoutparameter. The interval to sleep between attempts is configured by theintervalfield of thePatienceConfigpassed implicitly as the last parameter.If the eitherValuemethod of the underlying Scala future returns ascala.Somecontaining ascala.util.Failurecontaining ajava.util.concurrent.ExecutionException, and this exception contains a non-nullcause, that cause will be included in theTestFailedExceptionas its cause. TheExecutionExceptionwill be be included as theTestFailedException's cause only if theExecutionException's cause isnull.- future
- the future to query 
- timeout
- the - Timeoutconfiguration parameter
- fun
- the function to which pass the future's value when it is ready 
- config
- an - PatienceConfigobject containing- timeoutand- intervalparameters that are unused by this method
- returns
- the result of invoking the - funparameter
 - Definition Classes
- Futures
 
-   final  def whenReady[T, U](future: FutureConcept[T], timeout: Timeout, interval: Interval)(fun: (T) => U)(implicit config: PatienceConfig, pos: Position): UQueries the passed 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, passes the future's value to the passed function. Queries the passed 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, passes the future's value to the passed function. The maximum amount of time to tolerate unsuccessful queries before giving up and throwing TestFailedExceptionis configured by the value contained in the passedtimeoutparameter. The interval to sleep between attempts is configured by the value contained in the passedintervalparameter.If the eitherValuemethod of the underlying Scala future returns ascala.Somecontaining ascala.util.Failurecontaining ajava.util.concurrent.ExecutionException, and this exception contains a non-nullcause, that cause will be included in theTestFailedExceptionas its cause. TheExecutionExceptionwill be be included as theTestFailedException's cause only if theExecutionException's cause isnull.- future
- the future to query 
- timeout
- the - Timeoutconfiguration parameter
- interval
- the - Intervalconfiguration parameter
- fun
- the function to which pass the future's value when it is ready 
- config
- an - PatienceConfigobject containing- timeoutand- intervalparameters that are unused by this method
- returns
- the result of invoking the - funparameter
 - Definition Classes
- Futures
 
Deprecated Value Members
-    def finalize(): Unit- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated