Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.
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 RunStopped 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 RunStopped 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 RunStopped event like this:
report(RunStopped(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 optional amount of time, in milliseconds, that was required by the run that has stopped
an optional summary of the number of tests that were reported as succeeded, failed, ignored, and pending
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 object that can be used to pass custom information to the reporter about the RunStopped event
a name for the Thread about whose activity this event was reported
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
an Ordinal that can be used to place this event in order in the context of
other events reported during the same run
an optional amount of time, in milliseconds, that was required by the run that has stopped
an optional summary of the number of tests that were reported as succeeded, failed, ignored, and pending
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 object that can be used to pass custom information to the reporter about the RunStopped event
a name for the Thread about whose activity this event was reported
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
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.
the event to compare to this event
an optional amount of time, in milliseconds, that was required by the run that has stopped
an optional amount of time, in milliseconds, that was required by the run that has stopped
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 [http://en.wikipedia.org/wiki/Equivalence_relation 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 scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
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
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.
the hash code value for the object.
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
an optional object that can be used to pass custom information to the reporter about the RunStopped event
an optional object that can be used to pass custom information to the reporter about the RunStopped event
use productIterator instead
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
a name for the Thread about whose activity this event was reported
a name for the Thread about whose activity this event was reported
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
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.
Suite'sexecutemethod takes aStopper, whosestopRequestedmethod indicates a stop was requested. Iftrueis returned bystopRequestedwhile a suite of tests is running, theexecutemethod should promptly return even if that suite hasn't finished running all of its tests.If a stop was requested via the
Stopper.Runnerwill reportRunStoppedwhen theexecutemethod of the run's startingSuitereturns. If a stop is not requested,Runnerwill reportRunCompletedwhen the lastexecutemethod of the run's startingSuites returns.ScalaTest's
Runnerfires aRunStoppedreport with an emptysummary, 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 theRunStoppedwith a new one that is identical except that is has a definedsummary.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 aRunStoppedevent like this: