Packages

final case class RunStopped(ordinal: Ordinal, duration: Option[Long] = None, summary: Option[Summary] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime) extends Event with Product with Serializable

Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.

Suite's execute method takes a Stopper, whose stopRequested method indicates a stop was requested. If true is returned by stopRequested while a suite of tests is running, the execute method should promptly return even if that suite hasn't finished running all of its tests.

If a stop was requested via the Stopper. Runner will report RunStopped when the execute method of the run's starting Suite returns. If a stop is not requested, Runner will report RunCompleted when the last execute method of the run's starting Suites returns.

ScalaTest's Runner fires a RunStopped report with an empty summary, because the reporter is responsible for keeping track of the total number of tests reported as succeeded, failed, ignored, pending and canceled. ScalaTest's internal reporter replaces the RunStopped with a new one that is identical except that is has a defined summary.

To create instances of this class you may use the factory method. For example, given a report function named report, you could fire a RunStopped event like this:

report(RunStopped(ordinal))

ordinal

an Ordinal that can be used to place this event in order in the context of other events reported during the same run

duration

an optional amount of time, in milliseconds, that was required by the run that has stopped

summary

an optional summary of the number of tests that were reported as succeeded, failed, ignored pending and canceled

formatter

an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

location

An optional Location that provides information indicating where in the source code an event originated.

payload

an optional object that can be used to pass custom information to the reporter about the RunStopped event

threadName

a name for the Thread about whose activity this event was reported

timeStamp

a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Source
Event.scala
Linear Supertypes
Event, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RunStopped
  2. Event
  3. Serializable
  4. Product
  5. Equals
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RunStopped(ordinal: Ordinal, duration: Option[Long] = None, summary: Option[Summary] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime)

    ordinal

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    duration

    an optional amount of time, in milliseconds, that was required by the run that has stopped

    summary

    an optional summary of the number of tests that were reported as succeeded, failed, ignored pending and canceled

    formatter

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    location

    An optional Location that provides information indicating where in the source code an event originated.

    payload

    an optional object that can be used to pass custom information to the reporter about the RunStopped event

    threadName

    a name for the Thread about whose activity this event was reported

    timeStamp

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean
    Definition Classes
    Ordered
  4. def <=(that: Event): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean
    Definition Classes
    Ordered
  7. def >=(that: Event): Boolean
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def compare(that: Event): Int

    Comparing this event with the event passed as that.

    Comparing this event with the event passed as that. Returns x, where x < 0 iff this < that, x == 0 iff this == that, x > 0 iff this > that.

    that

    the event to compare to this event

    Definition Classes
    Event → Ordered
  11. def compareTo(that: Event): Int
    Definition Classes
    Ordered → Comparable
  12. val duration: Option[Long]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. val formatter: Option[Formatter]

    An optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user.

    An optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user.

    Definition Classes
    RunStopped → Event
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val location: Option[Location]

    An optional Location that provides information indicating where in the source code an event originated.

    An optional Location that provides information indicating where in the source code an event originated. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.

    Definition Classes
    RunStopped → Event
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val ordinal: Ordinal

    An Ordinal that can be used to place this event in order in the context of other events reported during the same run.

    An Ordinal that can be used to place this event in order in the context of other events reported during the same run.

    Definition Classes
    RunStopped → Event
  23. val payload: Option[Any]

    An optional object that can be used to pass custom information to the reporter about this event.

    An optional object that can be used to pass custom information to the reporter about this event.

    Definition Classes
    RunStopped → Event
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val summary: Option[Summary]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val threadName: String

    A name for the Thread about whose activity this event was reported.

    A name for the Thread about whose activity this event was reported.

    Definition Classes
    RunStopped → Event
  28. val timeStamp: Long

    A Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT.

    A Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT.

    Definition Classes
    RunStopped → Event
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Event

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped