c

org.scalatest.events

TestCanceled

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] = None, duration: Option[Long] = None, 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 ExceptionalEvent with Product with Serializable

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

To create instances of this class you may use the factory methods. For example, given a report function named report, you could fire a TestCanceled event like this:

report(TestCanceled(ordinal, userFriendlyName, suiteName, Some(thisSuite.getClass.getName), testName))

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

message

a localized message suitable for presenting to the user

suiteName

a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user

suiteId

a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run

suiteClassName

an optional fully qualifed Suite class name containing the test that was canceled

testName

the name of the test that was canceled

testText

the text of the test that was canceled (may be the test name, or a suffix of the test name)

recordedEvents

recorded events in the test.

throwable

an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.

duration

an optional amount of time, in milliseconds, that was required to run the test that was canceled

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 test that has canceled. (If None is passed, the test cannot be rerun.)

payload

an optional object that can be used to pass custom information to the reporter about the TestCanceled 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
ExceptionalEvent, Event, Serializable, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestCanceled
  2. ExceptionalEvent
  3. Event
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestCanceled(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = None, duration: Option[Long] = None, 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

    message

    a localized message suitable for presenting to the user

    suiteName

    a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user

    suiteId

    a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run

    suiteClassName

    an optional fully qualifed Suite class name containing the test that was canceled

    testName

    the name of the test that was canceled

    testText

    the text of the test that was canceled (may be the test name, or a suffix of the test name)

    recordedEvents

    recorded events in the test.

    throwable

    an optional Throwable that, if a Some, indicates why the test was canceled, or a Throwable created to capture stack trace information about the problem.

    duration

    an optional amount of time, in milliseconds, that was required to run the test that was canceled

    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 test that has canceled. (If None is passed, the test cannot be rerun.)

    payload

    an optional object that can be used to pass custom information to the reporter about the TestCanceled 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. val duration: Option[Long]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val formatter: Option[Formatter]
    Definition Classes
    TestCanceledEvent
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val location: Option[Location]
    Definition Classes
    TestCanceledEvent
  19. val message: String
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. val ordinal: Ordinal
    Definition Classes
    TestCanceledEvent
  24. val payload: Option[Any]
    Definition Classes
    TestCanceledEvent
  25. val recordedEvents: IndexedSeq[RecordableEvent]
  26. val rerunner: Option[String]
  27. val suiteClassName: Option[String]
  28. val suiteId: String
  29. val suiteName: String
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. val testName: String
  32. val testText: String
  33. val threadName: String
    Definition Classes
    TestCanceledEvent
  34. val throwable: Option[Throwable]
  35. val timeStamp: Long
    Definition Classes
    TestCanceledEvent
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExceptionalEvent

Inherited from Event

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped