org.scalatest.events.SuiteStarting

Event that indicates a suite of tests is about to start executing.

For example, trait Suite and object Runner use SuiteStarting to report that the execute method of a Suite is about to be invoked.

To create instances of this class you may use the factory method provided in its companion object. For example, given a report function named report, you could fire a SuiteStarting event like this:

report(SuiteStarting(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, it 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 is starting, suitable for presenting to the user
suiteId: a string ID for the suite that is starting, intended to be unique across all suites in a run XXX
suiteClassName: an optional fully qualifed Suite class name of the suite that is starting
decodedSuiteName: the decoded suite name, in case the suite name is put between backticks. None if it is same as suiteName.
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 is starting. (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 SuiteStarting 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

Attributes: final

Linear Supertypes

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

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

SuiteStarting
Serializable
Product
Equals
Event
Serializable
Ordered
Comparable
AnyRef
Any

Visibility

Public
All

Instance Constructors

new SuiteStarting (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], decodedSuiteName: Option[String], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], 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
suiteName
a localized name identifying the suite that is starting, suitable for presenting to the user
suiteId
a string ID for the suite that is starting, intended to be unique across all suites in a run XXX
suiteClassName
an optional fully qualifed Suite class name of the suite that is starting
decodedSuiteName
the decoded suite name, in case the suite name is put between backticks. None if it is same as suiteName.
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 is starting. (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 SuiteStarting 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

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def < (that: Event): Boolean

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

Definition Classes
Ordered
def == (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def > (that: Event): Boolean

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

Definition Classes
Ordered
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def canEqual (arg0: Any): Boolean

Definition Classes
SuiteStarting → Equals
def clone (): AnyRef

Attributes
protected[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 decodedSuiteName : Option[String]

the decoded suite name, in case the suite name is put between backticks.
the decoded suite name, in case the suite name is put between backticks. None if it is same as suiteName.
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
SuiteStarting → Equals → AnyRef → Any
def finalize (): Unit

Attributes
protected[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
SuiteStarting → Event
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

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

Attributes
final
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
SuiteStarting → Event
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

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

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

Definition Classes
SuiteStarting → Event
def productArity : Int

Definition Classes
SuiteStarting → Product
def productElement (arg0: Int): Any

Definition Classes
SuiteStarting → Product
def productIterator : Iterator[Any]

Definition Classes
Product
def productPrefix : String

Definition Classes
SuiteStarting → Product
val rerunner : Option[String]

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

an optional fully qualifed Suite class name of the suite that is starting
val suiteId : String

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

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

Attributes
final
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
SuiteStarting → 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
SuiteStarting → Event
def toString (): String

Definition Classes
SuiteStarting → AnyRef → Any
def toXml : Elem

Definition Classes
SuiteStarting → Event
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def productElements : Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
use productIterator instead

SuiteStarting

Instance Constructors

new SuiteStarting (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], decodedSuiteName: Option[String], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long)

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def < (that: Event): Boolean

def <= (that: Event): Boolean

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def > (that: Event): Boolean

def >= (that: Event): Boolean

def asInstanceOf [T0] : T0

def canEqual (arg0: Any): Boolean

def clone (): AnyRef

def compare (that: Event): Int

def compareTo (that: Event): Int

val decodedSuiteName : Option[String]

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

val formatter : Option[Formatter]

def getClass (): java.lang.Class[_]

def hashCode (): Int

def isInstanceOf [T0] : Boolean

val location : Option[Location]

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

val ordinal : Ordinal

val payload : Option[Any]

def productArity : Int

def productElement (arg0: Int): Any

def productIterator : Iterator[Any]

def productPrefix : String

val rerunner : Option[String]

val suiteClassName : Option[String]

val suiteId : String

val suiteName : String

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

val threadName : String

val timeStamp : Long

def toString (): String

def toXml : Elem

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

def productElements : Iterator[Any]

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