RunStarting

final case class RunStarting(ordinal: Ordinal, testCount: Int, configMap: ConfigMap, formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event

Event that indicates a runner is about run a suite of tests.

For example, object Runner reports RunStarting to indicate that the first execute method of a run's initial Suite is about to be invoked.

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

report(RunStarting(ordinal, testCount))
Value parameters:
configMap

a ConfigMap of key-value pairs that can be used by custom Reporters

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.

ordinal

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

payload

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

testCount

the number of tests expected during this run

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

Throws:
IllegalArgumentException

if testCount is less than zero.

class Event
trait Serializable
trait Product
trait Equals
trait Ordered[Event]
trait Comparable[Event]
class Object
trait Matchable
class Any

Value members

Inherited methods

def <(that: Event): Boolean
Inherited from:
Ordered
def <=(that: Event): Boolean
Inherited from:
Ordered
def >(that: Event): Boolean
Inherited from:
Ordered
def >=(that: Event): Boolean
Inherited from:
Ordered
def compare(that: Event): Int

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.

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.

Value parameters:
return

an integer indicating whether this event is less than, equal to, or greater than the passed event

that

the event to compare to this event

Inherited from:
Event
def compareTo(that: Event): Int
Inherited from:
Ordered
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product