RunStarting

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

Instance Constructors

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

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
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: AnyRef): Boolean

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

Definition Classes
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 configMap: Map[String, Any]

a Map of key-value pairs that can be used by custom Reporters
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

Definition Classes
Any
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
RunStarting → Event
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
RunStarting → Event
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val testCount: Int

the number of tests expected during this run
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
RunStarting → 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
RunStarting → 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()

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

Instance Constructors

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

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def <(that: Event): Boolean

def <=(that: Event): Boolean

final def ==(arg0: AnyRef): 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 configMap: Map[String, Any]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val formatter: Option[Formatter]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinal: Ordinal

val payload: Option[Any]

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

val testCount: Int

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