Trait/Object

org.scalatest

Stopper

Related Docs: object Stopper | package scalatest

Permalink

trait Stopper extends AnyRef

Trait whose instances can accept a stop request and indicate whether a stop has already been requested.

This is passed in to the run method of Suite, so that running suites of tests can be requested to stop early.

Source
Stopper.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stopper
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def requestStop(): Unit

    Permalink

    Request that the current run stop.

    Request that the current run stop.

    Invoking this method is like pulling the stop-request chord in a streetcar. It requests a stop, but in no way forces a stop. The running suite of tests decides when and how (and if) to respond to a stop request. ScalaTest's style traits periodically check the stopRequested method of the passed Stopper, and if a stop has been requested, terminates gracefully.

  2. abstract def stopRequested: Boolean

    Permalink

    Indicates whether a stop has been requested.

    Indicates whether a stop has been requested.

    Call this method to determine whether a running test should stop. The run method of any Suite, or code invoked by run, should periodically check the stop requested function. If true, the run method should interrupt its work and simply return.

    returns

    true if a stop has been requested