org.scalatest.events

RunStarting

final case class RunStarting(ordinal: Ordinal, testCount: Int, configMap: Map[String, Any], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) 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 one of the factory methods provided in its companion object. 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 Map 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

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.

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

Instance Constructors

  1. new RunStarting(ordinal: Ordinal, testCount: Int, configMap: Map[String, Any], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long)

    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 Map 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

    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. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Ordered
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def >(that: Event): Boolean

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

    Definition Classes
    Ordered
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

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

    Definition Classes
    Ordered → Comparable
  14. val configMap: Map[String, Any]

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

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. 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
    RunStartingEvent
  18. final def getClass(): Class[_]

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

    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. 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
    RunStartingEvent
  24. val payload: Option[Any]

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

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

    Definition Classes
    RunStartingEvent
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. val testCount: Int

    the number of tests expected during this run

  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
    RunStartingEvent
  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
    RunStartingEvent
  29. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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