Reporter

Trait whose instances collect the results of a running
suite of tests and presents those results in some way to the user. Instances of this trait can
be called "report functions" or "reporters."

Reporters receive test results via thirteen events.
Each event is fired to pass a particular kind of information to
the reporter. The events are:

RunStarting

TestStarting

TestSucceeded

TestFailed

TestIgnored

TestPending

SuiteStarting

SuiteCompleted

SuiteAborted

InfoProvided

RunStopped

RunAborted

RunCompleted

Reporters may be implemented such that they only present some of the reported events to the user. For example, you could
define a reporter class that doesn nothing in response to SuiteStarting events.
Such a class would always ignore SuiteStarting events.

The term test as used in the TestStarting, TestSucceeded,
and TestFailed event names
is defined abstractly to enable a wide range of test implementations.
Trait Suite fires TestStarting to indicate it is about to invoke one
of its test methods, TestSucceeded to indicate a test method returned normally,
and TestFailed to indicate a test method completed abruptly with an exception.
Although the execution of a Suite's test methods will likely be a common event
reported via theTestStarting, TestSucceeded, and TestFailed methods, because
of the abstract definition of &#8220;test&#8221; used by the
the event classes, these events are not limited to this use. Information about any conceptual test
may be reported via the TestStarting, TestSucceeded, andTestFailed events.

Likewise, the term suite as used in the SuiteStarting, SuiteAborted,
and SuiteCompleted event names
is defined abstractly to enable a wide range of suite implementations.
Object Runner fires SuiteStarting to indicate it is about to invokerun on aSuite, SuiteCompleted to indicate a Suite'srun method returned normally,
and SuiteAborted to indicate a Suite's runmethod completed abruptly with an exception.
Similarly, class Suite fires SuiteStarting to indicate it is about to invokerun on a
nested Suite, SuiteCompleted to indicate a nested Suite'srun method returned normally,
and SuiteAborted to indicate a nested Suite's runmethod completed abruptly with an exception.
Although the execution of a Suite's run method will likely be a
common event reported via theSuiteStarting, SuiteAborted, and SuiteCompleted events, because
of the abstract definition of "suite" used by the
event classes, these events are not limited to this use. Information about any conceptual suite
may be reported via the SuiteStarting, SuiteAborted, andSuiteCompleted events.

Extensibility

You can create classes that extend ReportFunction to report test results in custom ways, and to
report custom information passed as an event "payload." For more information on the latter
use case, see the Extensibility section of the Event documentation.

Reporter classes can handle events in any manner, including doing nothing.
For convenience, trait ReporterFunction includes a default implentation of apply that does nothing.

defasInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.

defeq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).

The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.

When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

arg0

the object to compare against this object for reference equality.

returns

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

attributes: final

definition classes: AnyRef

defequals(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 [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)).

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

deffinalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that
there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that
there are no more references to the object.

The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

attributes: protected

definition classes: AnyRef

defgetClass(): java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.

The nature of the representation is platform dependent.

returns

a representation that corresponds to the dynamic class of the receiver object.

attributes: final

definition classes: AnyRef

defhashCode(): 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.

returns

the hash code value for the object.

definition classes: AnyRef → Any

defisInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.

Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will
return true. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.

returns

true if the receiver object is an instance of erasure of type T0; false otherwise.

attributes: final

definition classes: Any

defne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).

arg0

the object to compare against this object for reference dis-equality.

returns

false if the argument is not a reference to the receiver object; true otherwise.

attributes: final

definition classes: AnyRef

defnotify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.

attributes: final

definition classes: AnyRef

defnotifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.