Provide information to the Reporter
as the
Provide information to the Reporter
as the .
an object whose toString
result will be forwarded to the wrapped Reporter
via an InfoProvided
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 equivalence relation:
x
of type Any
,
x.equals(x)
should return true
.x
and y
of type
Any
, x.equals(y)
should return true
if and only
if y.equals(x)
returns true
.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)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
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 a string representation of the object
Returns a string representation of the object.
The default representation is platform dependent.
Trait to which custom information about a running suite of tests can be reported.
An
Informer
is essentially used to wrap aReporter
and provide easy ways to send custom information to thatReporter
via anInfoProvided
event.Informer
contains anapply
method that takes an object. TheInformer
will invoketoString
on the passed object and forward the resulting string to the
Reporter
as themessage
parameter of anInfoProvided
event.Here's an example of using an
Informer
in aSuite
subclass:If you run this
Suite
from the interpreter, you will see the message included in the printed report:Traits
FunSuite
,Spec
,FlatSpec
,WordSpec
,FeatureSpec
, and their sister traits inorg.scalatest.fixture
package declare an implicitinfo
method that returns anInformer
. This implicitinfo
is used, for example, to enable the syntax offered by theGivenWhenThen
trait, which contains methods that take an implicitInformer
. Here's an example of aFeatureSpec
that mixes inGivenWhenThen
:Were you to run this
FeatureSpec
in the interpreter, you would see the following messages included in the printed report: