This class supports the syntax of FlatSpec
, WordSpec
, FixtureFlatSpec
,
and FixtureWordSpec
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object.
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.
Provides an implicit conversion that adds
should
methods toString
to support the syntax ofFlatSpec
,WordSpec
,FixtureFlatSpec
, andFixtureWordSpec
.For example, this trait enables syntax such as the following test registration in
FlatSpec
andFixtureFlatSpec
:It also enables syntax such as the following shared test registration in
FlatSpec
andFixtureFlatSpec
:In addition, it supports the registration of subject descriptions in
WordSpec
andFixtureWordSpec
, such as:And finally, it also supportds the registration of subject descriptions with after words in
WordSpec
andFixtureWordSpec
. For example:The reason this implicit conversion is provided in a separate trait, instead of being provided directly in
FlatSpec
,WordSpec
,FixtureFlatSpec
, andFixtureWordSpec
, is because an implicit conversion provided directly would conflict with the implicit conversion that providesshould
methods onString
in theShouldMatchers
trait. By contrast, there is no conflict with the separateShouldVerb
trait approach, because:FlatSpec
,WordSpec
,FixtureFlatSpec
, andFixtureWordSpec
mix inShouldVerb
directly, andShouldMatchers
extendsShouldVerb
, overriding theconvertToStringShouldWrapper
implicit conversion function.So whether or not a
Also, because the class of the result of the overridingFlatSpec
,WordSpec
,FixtureFlatSpec
, orFixtureWordSpec
mixes inShouldMatchers
, there will only be one implicit conversion in scope that addsshould
methods toString
s.convertToStringShouldWrapper
implicit conversion method provided inShouldMatchers
extends this trait'sStringShouldWrapperForVerb
class, the four uses ofshould
provided here are still available. These fourshould
are in fact available to any class that mixes inShouldMatchers
, but each takes an implicit parameter that is provided only inFlatSpec
andFixtureFlatSpec
, orWordSpec
andFixtureWordSpec
.