scalatestCoreDotty/org.scalatest.events/Event

Event

sealed abstract class Event extends Ordered[Event] with Product with Serializable

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

trait Serializable
trait Product
trait Equals
trait Ordered[Event]
trait Comparable[Event]
class Object
trait Matchable
class Any

Value members

Concrete methods

def compare(that: Event): Int

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.

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.

Value parameters:
return

an integer indicating whether this event is less than, equal to, or greater than the passed event

that

the event to compare to this event

Inherited methods

def <(that: Event): Boolean
Inherited from:
Ordered
def <=(that: Event): Boolean
Inherited from:
Ordered
def >(that: Event): Boolean
Inherited from:
Ordered
def >=(that: Event): Boolean
Inherited from:
Ordered
def canEqual(that: Any): Boolean
Inherited from:
Equals
def compareTo(that: Event): Int
Inherited from:
Ordered
def productArity: Int
Inherited from:
Product
def productElement(n: Int): Any
Inherited from:
Product
def productElementName(n: Int): String
Inherited from:
Product
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def productPrefix: String
Inherited from:
Product

Abstract fields

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.

val location: Option[Location]

An optional Location that provides information indicating where in the source code an event originated. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.

An optional Location that provides information indicating where in the source code an event originated. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.

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.

val payload: Option[Any]

An optional object that can be used to pass custom information to the reporter about this event.

An optional object that can be used to pass custom information to the reporter about this event.

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.

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.