RunCompleted

Event that indicates a runner has completed running a suite of tests.

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 RunCompleted 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 RunCompleted 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 RunCompleted event like this:

report(RunCompleted(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 completed
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 RunCompleted 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

Serializable, Product, Equals, Event, Serializable, Ordered[Event], Comparable[Event], AnyRef, Any

Instance Constructors

new RunCompleted(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 completed
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 RunCompleted 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

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def <(that: Event): Boolean

Definition Classes
Ordered
def <=(that: Event): Boolean

Definition Classes
Ordered
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def >(that: Event): Boolean

Definition Classes
Ordered
def >=(that: Event): Boolean

Definition Classes
Ordered
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
def compareTo(that: Event): Int

Definition Classes
Ordered → Comparable
val duration: Option[Long]

an optional amount of time, in milliseconds, that was required by the run that has completed
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
RunCompleted → Event
final def getClass(): Class[_]

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

Definition Classes
Any
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.

Definition Classes
RunCompleted → Event
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
RunCompleted → Event
val payload: Option[Any]

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

Definition Classes
RunCompleted → Event
val summary: Option[Summary]

an optional Summary of the number of tests that were reported as succeeded, failed, ignored, pending and canceled
an optional Summary of the number of tests that were reported as succeeded, failed, ignored, pending and canceled
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
RunCompleted → Event
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
RunCompleted → Event
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package events

Instance Constructors

new RunCompleted(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)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def <(that: Event): Boolean

def <=(that: Event): Boolean

final def ==(arg0: Any): Boolean

def >(that: Event): Boolean

def >=(that: Event): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compare(that: Event): Int

def compareTo(that: Event): Int

val duration: Option[Long]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val formatter: Option[Formatter]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val location: Option[Location]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinal: Ordinal

val payload: Option[Any]

val summary: Option[Summary]

final def synchronized[T0](arg0: ⇒ T0): T0

val threadName: String

val timeStamp: Long

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Event

Inherited from Serializable

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped