c

org.scalatest.events

RunStarting

final case class RunStarting(ordinal: Ordinal, testCount: Int, configMap: ConfigMap, 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 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))

ordinal

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

testCount

the number of tests expected during this run

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.

payload

an optional object that can be used to pass custom information to the reporter about the RunStarting 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
Exceptions thrown

IllegalArgumentException if testCount is less than zero.

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

Instance Constructors

  1. new RunStarting(ordinal: Ordinal, testCount: Int, configMap: ConfigMap, 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

    testCount

    the number of tests expected during this run

    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.

    payload

    an optional object that can be used to pass custom information to the reporter about the RunStarting 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

    Exceptions thrown

    IllegalArgumentException if testCount is less than zero.

Value Members

  1. def <(that: Event): Boolean
    Definition Classes
    Ordered
  2. def <=(that: Event): Boolean
    Definition Classes
    Ordered
  3. def >(that: Event): Boolean
    Definition Classes
    Ordered
  4. def >=(that: Event): Boolean
    Definition Classes
    Ordered
  5. 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
  6. def compareTo(that: Event): Int
    Definition Classes
    Ordered → Comparable
  7. val configMap: ConfigMap
  8. val formatter: Option[Formatter]
    Definition Classes
    RunStarting → Event
  9. val location: Option[Location]
    Definition Classes
    RunStarting → Event
  10. val ordinal: Ordinal
    Definition Classes
    RunStarting → Event
  11. val payload: Option[Any]
    Definition Classes
    RunStarting → Event
  12. val testCount: Int
  13. val threadName: String
    Definition Classes
    RunStarting → Event
  14. val timeStamp: Long
    Definition Classes
    RunStarting → Event