org.scalatest.events

Event

class Event extends Ordered[Event]

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

Will have a sealed abstract InfoProvided message with three final concrete subclasses, RunInfoProvided, SuiteInfoProvided, TestInfoProvided. Anything that starts with Run just has runStamp and ordinal; Suite has those plus suiteStamp; Test has those plus testStamp.

attributes: sealed abstract
known subclasses: TestSucceeded, TestStarting, TestPending, TestIgnored, TestFailed, SuiteStarting, SuiteCompleted, SuiteAborted, RunStopped, RunStarting, RunCompleted, RunAborted, InfoProvided

Inherits

  1. Ordered
  2. Comparable
  3. AnyRef
  4. Any

Value Members

  1. def <(that: Event): Boolean

  2. def <=(that: Event): Boolean

  3. def >(that: Event): Boolean

  4. def >=(that: Event): Boolean

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

  6. def compareTo(that: Event): Int

  7. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  8. 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.

    attributes: abstract
  9. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  10. 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.

    attributes: abstract
  11. 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.

    attributes: abstract
  12. 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.

    attributes: abstract
  13. 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.

    attributes: abstract
  14. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any

Instance constructors

  1. new Event()