Class

org.scalatest.events

RunAborted

Related Doc: package events

Permalink

final case class RunAborted(ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long] = None, summary: Option[Summary] = None, formatter: Option[Formatter] = None, location: Option[Location] = 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 runner encountered an error while attempting to run a suite of tests.

For example, object Runner reports RunAborted if the execute method of any of the run's starting Suites completes abruptly with a Throwable.

ScalaTest's Runner fires a RunAborted report with an empty summary, because the reporter is responsible for keeping track of the total number of tests reported as succeeded, failed, ignored, and pending. ScalaTest's internal reporter replaces the RunAborted with a new one that is identical except that is has a defined summary.

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

report(RunAborted(ordinal, message, Some(exception)))

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

throwable

an optional Throwable that, if a Some, indicates why the run has aborted, or a Throwable created to capture stack trace information about the problem.

duration

an optional amount of time, in milliseconds, that was required by the run that has aborted

summary

an optional Summary of the number of tests that were reported as succeeded, failed, ignored, and pending

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.

payload

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

Instance Constructors

  1. new RunAborted(ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long] = None, summary: Option[Summary] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime)

    Permalink

    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

    throwable

    an optional Throwable that, if a Some, indicates why the run has aborted, or a Throwable created to capture stack trace information about the problem.

    duration

    an optional amount of time, in milliseconds, that was required by the run that has aborted

    summary

    an optional Summary of the number of tests that were reported as succeeded, failed, ignored, and pending

    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.

    payload

    an optional object that can be used to pass custom information to the reporter about the RunAborted 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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  4. def <=(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  7. def >=(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compare(that: Event): Int

    Permalink

    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

    Permalink
    Definition Classes
    Ordered → Comparable
  12. val duration: Option[Long]

    Permalink

    an optional amount of time, in milliseconds, that was required by the run that has aborted

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val formatter: Option[Formatter]

    Permalink

    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
    RunAbortedEvent
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val location: Option[Location]

    Permalink

    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.

    Definition Classes
    RunAbortedEvent
  19. val message: String

    Permalink

    a localized message suitable for presenting to the user

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val ordinal: Ordinal

    Permalink

    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
    RunAbortedEvent
  24. val payload: Option[Any]

    Permalink

    an optional object that can be used to pass custom information to the reporter about the RunAborted event

    an optional object that can be used to pass custom information to the reporter about the RunAborted event

    Definition Classes
    RunAbortedEvent
  25. val summary: Option[Summary]

    Permalink

    an optional Summary of the number of tests that were reported as succeeded, failed, ignored, and pending

    an optional Summary of the number of tests that were reported as succeeded, failed, ignored, and pending

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. val threadName: String

    Permalink

    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
    RunAbortedEvent
  28. val throwable: Option[Throwable]

    Permalink

    an optional Throwable that, if a Some, indicates why the run has aborted, or a Throwable created to capture stack trace information about the problem.

    an optional Throwable that, if a Some, indicates why the run has aborted, or a Throwable created to capture stack trace information about the problem.

  29. val timeStamp: Long

    Permalink

    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
    RunAbortedEvent
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Ungrouped