org.scalatest.events

RunAborted

case class RunAborted (ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], location: Option[Location], 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.

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 provided in its companion object. 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 suite 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

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. RunAborted
  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 RunAborted (ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], location: Option[Location], 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

    message

    a localized message suitable for presenting to the user

    throwable

    an optional Throwable that, if a Some, indicates why the suite 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. 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
    RunAborted → 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. val duration : Option[Long]

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

  16. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  17. def equals (arg0: Any): Boolean

    Definition Classes
    RunAborted → Equals → AnyRef → Any
  18. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  19. 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
    RunAbortedEvent
  20. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef
  21. def hashCode (): Int

    Definition Classes
    RunAborted → AnyRef → Any
  22. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  23. val location : Option[Location]

    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
  24. val message : String

    a localized message suitable for presenting to the user

  25. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  26. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  27. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  28. 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
    RunAbortedEvent
  29. val payload : Option[Any]

    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
  30. def productArity : Int

    Definition Classes
    RunAborted → Product
  31. def productElement (arg0: Int): Any

    Definition Classes
    RunAborted → Product
  32. def productIterator : Iterator[Any]

    Definition Classes
    Product
  33. def productPrefix : String

    Definition Classes
    RunAborted → Product
  34. val summary : Option[Summary]

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  36. 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
    RunAbortedEvent
  37. val throwable : Option[Throwable]

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

  38. 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
    RunAbortedEvent
  39. def toString (): String

    Definition Classes
    RunAborted → AnyRef → Any
  40. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  43. 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