SuiteCompleted

Event that indicates a suite of tests has completed executing.

For example, trait Suite and object Runner use SuiteCompleted to report that the execute method of a Suite has returned normally (without throwing a RuntimeException).

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

report(SuiteCompleted(ordinal, userFriendlyName, suiteName, Some(thisSuite.getClass.getName)))

The suite class name parameter is optional, because suites in ScalaTest are an abstraction that need not necessarily correspond to one class. Nevertheless, in most cases each suite will correspond to a class, and when it does, the fully qualified name of that class should be reported by passing a Some for suiteClassName. One use for this bit of information is JUnit integration, because the "name" provided to a JUnit org.junit.runner.Description appears to usually include a fully qualified class name by convention.

ordinal: an Ordinal that can be used to place this event in order in the context of other events reported during the same run
suiteName: a localized name identifying the suite that has completed, suitable for presenting to the user
suiteId: a string ID for the suite that has completed, intended to be unique across all suites in a run
suiteClassName: an optional fully qualifed Suite class name containing the suite that has completed
duration: an optional amount of time, in milliseconds, that was required to execute the suite that has completed
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.
rerunner: an optional String giving the fully qualified name of the class that can be used to rerun the suite that has completed. (If None is passed, the suite cannot be rerun.)
payload: an optional object that can be used to pass custom information to the reporter about the SuiteCompleted 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

Linear Supertypes

Event, Serializable, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any

Instance Constructors

new SuiteCompleted(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], duration: Option[Long] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, rerunner: Option[String] = 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
suiteName
a localized name identifying the suite that has completed, suitable for presenting to the user
suiteId
a string ID for the suite that has completed, intended to be unique across all suites in a run
suiteClassName
an optional fully qualifed Suite class name containing the suite that has completed
duration
an optional amount of time, in milliseconds, that was required to execute the suite that has completed
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.
rerunner
an optional String giving the fully qualified name of the class that can be used to rerun the suite that has completed. (If None is passed, the suite cannot be rerun.)
payload
an optional object that can be used to pass custom information to the reporter about the SuiteCompleted 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

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 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 duration: Option[Long]

an optional amount of time, in milliseconds, that was required to execute the suite that has completed
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]

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
SuiteCompleted → Event
final def getClass(): Class[_]

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

Definition Classes
Any
val location: Option[Location]

An optional Location that provides information indicating where in the source code an event originated.
An optional Location that provides information indicating where in the source code an event originated.

Definition Classes
SuiteCompleted → 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

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
SuiteCompleted → Event
val payload: Option[Any]

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

Definition Classes
SuiteCompleted → Event
val rerunner: Option[String]

an optional String giving the fully qualified name of the class that can be used to rerun the suite that has completed.
an optional String giving the fully qualified name of the class that can be used to rerun the suite that has completed. (If None is passed, the suite cannot be rerun.)
val suiteClassName: Option[String]

an optional fully qualifed Suite class name containing the suite that has completed
an optional fully qualifed Suite class name containing the suite that has completed
val suiteId: String

a string ID for the suite that has completed, intended to be unique across all suites in a run
val suiteName: String

a localized name identifying the suite that has completed, suitable for presenting to the user
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
SuiteCompleted → 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
SuiteCompleted → 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( ... )

Related Doc: package events

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def <(that: Event): Boolean

def <=(that: Event): 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 duration: Option[Long]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val formatter: Option[Formatter]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val location: Option[Location]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinal: Ordinal

val payload: Option[Any]

val rerunner: Option[String]

val suiteClassName: Option[String]

val suiteId: String

val suiteName: String

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

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 Event

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped