Packages

c

org.scalatest.events

SuiteStarting

final case class SuiteStarting(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], 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) extends Event with Product with Serializable

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. 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, 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 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

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

Source
Event.scala
Linear Supertypes
Event, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SuiteStarting
  2. Event
  3. Serializable
  4. Product
  5. Equals
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SuiteStarting(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], 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 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

    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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean
    Definition Classes
    Ordered
  4. def <=(that: Event): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean
    Definition Classes
    Ordered
  7. def >=(that: Event): Boolean
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. 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
  11. def compareTo(that: Event): Int
    Definition Classes
    Ordered → Comparable
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. 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
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.

    Definition Classes
    SuiteStarting → Event
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. 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
  22. val payload: Option[Any]

    An optional object that can be used to pass custom information to the reporter about this event.

    An optional object that can be used to pass custom information to the reporter about this event.

    Definition Classes
    SuiteStarting → Event
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val rerunner: Option[String]
  25. val suiteClassName: Option[String]
  26. val suiteId: String
  27. val suiteName: String
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. 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
  30. 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
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Event

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped