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 customReporter
s- 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
iftestCount
is less than zero.
- Alphabetic
- By Inheritance
- RunStarting
- Event
- Serializable
- Serializable
- Product
- Equals
- Ordered
- Comparable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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 customReporter
s- 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
iftestCount
is less than zero.
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 asthat
.Comparing
this
event with the event passed asthat
. 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: ConfigMap
-
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]
- Definition Classes
- RunStarting → Event
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
location: Option[Location]
- Definition Classes
- RunStarting → 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
- Definition Classes
- RunStarting → Event
-
val
payload: Option[Any]
- Definition Classes
- RunStarting → Event
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val testCount: Int
-
val
threadName: String
- Definition Classes
- RunStarting → Event
-
val
timeStamp: Long
- 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( ... )