events

Type Members

1. final case class AlertProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with NotificationEvent with Product with Serializable

   Event used to provide alert notifications.

2. final case class DiscoveryCompleted(ordinal: Ordinal, duration: Option[Long] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

   Event that indicates a runner has completed searching for suites.

3. final case class DiscoveryStarting(ordinal: Ordinal, configMap: ConfigMap, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

   Event that indicates a runner is beginning search for suites to run.

4. sealed abstract class Event extends Ordered[Event] with Serializable

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

5. sealed trait ExceptionalEvent extends Event

   Marker trait for test failed and test canceled events.

6. sealed abstract class Formatter extends AnyRef

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

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

8. final case class InfoProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with RecordableEvent with Product with Serializable

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

9. final case class LineInFile(lineNumber: Int, fileName: String) extends Location with Product with Serializable

   An arbitrary line number in a named source file.

10. sealed abstract class Location extends AnyRef

    Location in source code indicating where in the source code an event originated.

11. final case class MarkupProvided(ordinal: Ordinal, text: String, nameInfo: Option[NameInfo], formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with RecordableEvent with Product with Serializable

    Event used to provide markup text for document-style reports.

12. final case class NameInfo(suiteName: String, suiteId: String, suiteClassName: Option[String], testName: Option[String]) extends Product with Serializable

    Class that holds information about names for the information events InfoProvided, MarkupProvided, ScopeOpened, ScopeClosed, ScopePending, AlertProvided and NoteProvided.

13. final case class NoteProvided(ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with NotificationEvent with Product with Serializable

    Event used to provide notifications.

14. sealed trait NotificationEvent extends Event

    Marker trait for the "notification" events NoteProvided and AlertProvided.

15. final class Ordinal extends Ordered[Ordinal] with Serializable

    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.

16. sealed trait RecordableEvent extends Event

    Marker trait for test completed event's recordedEvents.

17. final case class RunAborted(ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long] = scala.None, summary: Option[Summary] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

18. final case class RunCompleted(ordinal: Ordinal, duration: Option[Long] = scala.None, summary: Option[Summary] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

19. final case class RunStarting(ordinal: Ordinal, testCount: Int, configMap: ConfigMap, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

20. final case class RunStopped(ordinal: Ordinal, duration: Option[Long] = scala.None, summary: Option[Summary] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) 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.

21. final case class ScopeClosed(ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

    Event that indicates a scope has been closed.

22. final case class ScopeOpened(ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

    Event that indicates a new scope has been opened.

23. final case class ScopePending(ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

    Event that indicates a scope is pending.

24. final case class SuiteAborted(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], throwable: Option[Throwable] = scala.None, duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) 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.

25. final case class SuiteCompleted(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

    Event that indicates a suite of tests has completed executing.

26. final case class SuiteStarting(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

27. final case class Summary(testsSucceededCount: Int, testsFailedCount: Int, testsIgnoredCount: Int, testsPendingCount: Int, testsCanceledCount: Int, suitesCompletedCount: Int, suitesAbortedCount: Int, scopesPendingCount: Int) extends Product with Serializable

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

28. final case class TestCanceled(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = scala.None, duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with ExceptionalEvent with Product with Serializable

    Event that indicates a test was canceled, i.e., it couldn't run because some precondition was not met.

29. final case class TestFailed(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = scala.None, duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with ExceptionalEvent with Product with Serializable

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

30. final case class TestIgnored(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

31. final case class TestPending(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

32. final case class TestStarting(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) is about to start running a test.

33. final case class TestSucceeded(ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], duration: Option[Long] = scala.None, formatter: Option[Formatter] = scala.None, location: Option[Location] = scala.None, rerunner: Option[String] = scala.None, payload: Option[Any] = scala.None, threadName: String = ..., timeStamp: Long = new java.util.Date().getTime()) extends Event with Product with Serializable

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

34. final case class TopOfClass(className: String) extends Location with Product with Serializable

    The location in a source file where the class whose by the fully qualified name is passed as className is declared.

35. final case class TopOfMethod(className: String, methodId: String) extends Location with Product with Serializable

    The location in a source file where the method identified by the passed methodId in the class whose fully qualified name is pased as className is declared.