org.scalatest

# events

#### package events

Visibility

1. Public
2. All

### Type Members

1. #### class Event extends Ordered[Event]

   A base class for the events that can be passed to the report function passed to the `execute` method of a `Suite`.

2. #### class Formatter extends AnyRef

   Abstract class for the optional formatter objects that must be passed to the `Event`s reported during a ScalaTest run.

3. #### case class IndentedText (formattedText: String, rawText: String, indentationLevel: Int) extends Formatter with Product with Serializable

   A `Formatter` providing information that enables reporters to create more stylized output.

4. #### case class InfoProvided (ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], aboutAPendingTest: Option[Boolean], throwable: Option[Throwable], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

   Event used to provide information that is not appropriate to report via any other `Event`.

5. #### case class NameInfo (suiteName: String, suiteClassName: Option[String], testName: Option[String]) extends Product with Serializable

   Class that holds information about names for an `InfoProvided` event.

6. #### class Ordinal extends Ordered[Ordinal]

   Class used to specify a sequential order for events reported during a test run, so they can be arranged in that order in a report even if the events were fired in some other order during concurrent or distributed execution.

7. #### case class RunAborted (ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

   Event that indicates a runner encountered an error while attempting to run a suite of tests.

8. #### case class RunCompleted (ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

   Event that indicates a runner has completed running a suite of tests.

9. #### case class RunStarting (ordinal: Ordinal, testCount: Int, configMap: Map[String, Any], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

   Event that indicates a runner is about run a suite of tests.

10. #### case class RunStopped (ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.

11. #### case class SuiteAborted (ordinal: Ordinal, message: String, suiteName: String, suiteClassName: Option[String], throwable: Option[Throwable], duration: Option[Long], formatter: Option[Formatter], rerunner: Option[Rerunner], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates the execution of a suite of tests has aborted, likely because of an error, prior to completion.

12. #### case class SuiteCompleted (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], duration: Option[Long], 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 has completed executing.

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

14. #### case class Summary (testsSucceededCount: Int, testsFailedCount: Int, testsIgnoredCount: Int, testsPendingCount: Int, suitesCompletedCount: Int, suitesAbortedCount: Int) extends Product with Serializable

    Class each of whose instances hold summary information about one ScalaTest run.

15. #### case class TestFailed (ordinal: Ordinal, message: String, suiteName: String, suiteClassName: Option[String], testName: String, throwable: Option[Throwable], duration: Option[Long], formatter: Option[Formatter], rerunner: Option[Rerunner], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has completed running a test that failed.

16. #### case class TestIgnored (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], testName: String, formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has ignored a test.

17. #### case class TestPending (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], testName: String, formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a test is pending, i.e., it hasn't yet been implemented.

18. #### case class TestStarting (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], testName: 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 (or other entity) is about to start running a test.

19. #### case class TestSucceeded (ordinal: Ordinal, suiteName: String, suiteClassName: Option[String], testName: String, duration: Option[Long], formatter: Option[Formatter], rerunner: Option[Rerunner], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has completed running a test that succeeded.

### Value Members

1. #### object InfoProvided extends Serializable

   Companion object for the `InfoProvided` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `InfoProvided` objects.

2. #### object MotionToSuppress extends Formatter with Product with Serializable

   A `Formatter` that indicates reporters may wish to suppress reporting of an `Event`.

3. #### object NameInfo extends Serializable

   Companion object for case class `NameInfo`.

4. #### object RunAborted extends Serializable

   Companion object for the `RunAborted` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `RunAborted` objects.

5. #### object RunCompleted extends Serializable

   Companion object for the `RunCompleted` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `RunCompleted` objects.

6. #### object RunStarting extends Serializable

   Companion object for the `RunStarting` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `RunStarting` objects.

7. #### object RunStopped extends Serializable

   Companion object for the `RunStopped` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `RunStopped` objects.

8. #### object SuiteAborted extends Serializable

   Companion object for the `SuiteAborted` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `SuiteAborted` objects.

9. #### object SuiteCompleted extends Serializable

   Companion object for the `SuiteCompleted` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `SuiteCompleted` objects.

10. #### object SuiteStarting extends Serializable

    Companion object for the `SuiteStarting` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `SuiteStarting` objects.

11. #### object Summary extends Serializable

    Companion object for case class `Summary`.

12. #### object TestFailed extends Serializable

    Companion object for the `TestFailed` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `TestFailed` objects.

13. #### object TestIgnored extends Serializable

    Companion object for the `TestIgnored` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `TestIgnored` objects.

14. #### object TestPending extends Serializable

    Companion object for the `TestPending` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `TestPending` objects.

15. #### object TestStarting extends Serializable

    Companion object for the `TestStarting` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `TestStarting` objects.

16. #### object TestSucceeded extends Serializable

    Companion object for the `TestSucceeded` event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on `TestSucceeded` objects.