org.scalatest.events

RunCompleted

class RunCompleted(ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product

Event that indicates a runner has completed running a suite of tests.

Suite's execute method takes a Stopper, whose stopRequested method indicates a stop was requested. If true is returned by stopRequested while a suite of tests is running, the execute method should promptly return even if that suite hasn't finished running all of its tests.

If a stop was requested via the Stopper. Runner will report RunStopped when the execute method of the run's starting Suite returns. If a stop is not requested, Runner will report RunCompleted when the last execute method of the run's starting Suites returns.

ScalaTest's Runner fires a RunCompleted 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 RunCompleted with a new one that is identical except that is has a defined summary.

To create instances of this class you may use one of the factory methods provided in its companion object. For example, given a report function named report, you could fire a RunCompleted event like this:

report(RunCompleted(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

duration

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

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

payload

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

Inherits

  1. Product
  2. Equals
  3. Event
  4. Ordered
  5. Comparable
  6. AnyRef
  7. 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 canEqual(arg0: Any): Boolean

  6. 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
    Go to: companion
  7. def compareTo(that: Event): Int

  8. val duration: Option[Long]

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

    Go to: companion
  10. 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.

    Go to: companion
  11. 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.

    Go to: companion
  12. 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.

    Go to: companion
  13. 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.

    Go to: companion
  14. def productArity: Int

  15. def productElement(arg0: Int): Any

  16. def productElements: Iterator[Any]

  17. def productIterator: Iterator[Any]

  18. def productPrefix: String

  19. val summary: Option[Summary]

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

    Go to: companion
  21. 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.

    Go to: companion
  22. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    Go to: companion

Instance constructors

  1. new RunCompleted(ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], payload: Option[Any], threadName: String, timeStamp: Long)

  2. new RunCompleted()