org.scalatest.events

SuiteStarting

case class SuiteStarting (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], formatter: Option[Formatter], rerunner: Option[Rerunner], payload: Option[Any], threadName: String, timeStamp: Long) 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 one of the factory methods 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, which should include the suite name, suitable for presenting to the user

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

rerunner

an optional Rerunner 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
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SuiteStarting
  2. Serializable
  3. Product
  4. Equals
  5. Event
  6. Serializable
  7. Ordered
  8. Comparable
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SuiteStarting (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], formatter: Option[Formatter], rerunner: Option[Rerunner], 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, which should include the suite name, suitable for presenting to the user

    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

    rerunner

    an optional Rerunner 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. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def < (that: Event): Boolean

    Definition Classes
    Ordered

  5. def <= (that: Event): Boolean

    Definition Classes
    Ordered

  6. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  7. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  8. def > (that: Event): Boolean

    Definition Classes
    Ordered

  9. def >= (that: Event): Boolean

    Definition Classes
    Ordered

  10. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  11. def canEqual (arg0: Any): Boolean

    Definition Classes
    SuiteStarting → Equals

  12. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

  14. def compareTo (that: Event): Int

    Definition Classes
    Ordered → Comparable

  15. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  16. def equals (arg0: Any): Boolean

    Definition Classes
    SuiteStarting → Equals → AnyRef → Any

  17. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

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

    Attributes
    final
    Definition Classes
    AnyRef

  20. def hashCode (): Int

    Definition Classes
    SuiteStarting → AnyRef → Any

  21. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  22. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  23. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  24. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

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

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

  27. def productArity : Int

    Definition Classes
    SuiteStarting → Product

  28. def productElement (arg0: Int): Any

    Definition Classes
    SuiteStarting → Product

  29. def productIterator : Iterator[Any]

    Definition Classes
    Product

  30. def productPrefix : String

    Definition Classes
    SuiteStarting → Product

  31. val rerunner : Option[Rerunner]

    an optional Rerunner that can be used to rerun the suite that is starting (if None is passed, the suite cannot be rerun)

  32. val suiteClassName : Option[String]

    an optional fully qualifed Suite class name of the suite that is starting

  33. val suiteName : String

    a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user

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

    Attributes
    final
    Definition Classes
    AnyRef

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

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

  37. def toString (): String

    Definition Classes
    SuiteStarting → AnyRef → Any

  38. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  40. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  41. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

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