Event that indicates a suite of tests is about to start executing.
For example, trait Suite and object Runner use SuiteStarting to report
that the execute method of a Suite is about to be invoked.
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 SuiteStarting event like this:
report(SuiteStarting(ordinal, userFriendlyName, suiteName, Some(thisSuite.getClass.getName)))
The suite class name parameter is optional, because suites in ScalaTest are an abstraction that
need not necessarily correspond to one class. Nevertheless, it most cases each suite will correspond
to a class, and when it does, the fully qualified name of that class should be reported by passing a
Some for suiteClassName. One use for this bit of information is JUnit integration,
because the "name" provided to a JUnit org.junit.runner.Description appears to usually include
a fully qualified class name by convention.
an Ordinal that can be used to place this event in order in the context of
other events reported during the same run
a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
an optional fully qualifed Suite class name of the suite that is starting
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 Rerunner that can be used to rerun the suite that is starting (if None
is passed, the suite cannot be rerun)
an optional object that can be used to pass custom information to the reporter about the SuiteStarting 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
a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
an optional fully qualifed Suite class name of the suite that is starting
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 Rerunner that can be used to rerun the suite that is starting (if None
is passed, the suite cannot be rerun)
an optional object that can be used to pass custom information to the reporter about the SuiteStarting 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
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 SuiteStarting event
an optional object that can be used to pass custom information to the reporter about the SuiteStarting event
use productIterator instead
an optional Rerunner that can be used to rerun the suite that is starting (if None
is passed, the suite cannot be rerun)
an optional Rerunner that can be used to rerun the suite that is starting (if None
is passed, the suite cannot be rerun)
an optional fully qualifed Suite class name of the suite that is starting
an optional fully qualifed Suite class name of the suite that is starting
a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
a localized name identifying the suite that is starting, which should include the suite name, suitable for presenting to the user
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 suite of tests is about to start executing.
For example, trait
Suiteand objectRunneruseSuiteStartingto report that theexecutemethod of aSuiteis about to be invoked.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 aSuiteStartingevent like this:The suite class name parameter is optional, because suites in ScalaTest are an abstraction that need not necessarily correspond to one class. Nevertheless, it most cases each suite will correspond to a class, and when it does, the fully qualified name of that class should be reported by passing a
SomeforsuiteClassName. One use for this bit of information is JUnit integration, because the "name" provided to a JUnitorg.junit.runner.Descriptionappears to usually include a fully qualified class name by convention.