Check to see if a Boolean
property on the specified object, objectWithProperty
, matches its
expected value, and report the result in
the returned BePropertyMatchResult
Check to see if a Boolean
property on the specified object, objectWithProperty
, matches its
expected value, and report the result in
the returned BePropertyMatchResult
. The objectWithProperty
is
usually the value to the left of a should
or must
invocation. For example, tempFile
would be passed as the objectWithProperty
in:
tempFile should be a (file)
the object with the Boolean
property against which to match
the BePropertyMatchResult
that represents the result of the match
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 extended by matcher objects, which may appear after the word
be
, that can match against aBoolean
property. The match will succeed if and only if theBoolean
property equalstrue
. The object containing the property, which must be of the type specified by theBePropertyMatcher
's type parameterT
, is passed to theBePropertyMatcher
'sapply
method. The result is aBePropertyMatchResult
. ABePropertyMatcher
is, therefore, a function from the specified type,T
, to aBePropertyMatchResult
.Although
BePropertyMatcher
andMatcher
represent similar concepts, they have no inheritance relationship becauseMatcher
is intended for use right aftershould
ormust
whereasBePropertyMatcher
is intended for use right afterbe
.A
BePropertyMatcher
essentially allows you to write statically typedBoolean
property assertions similar to the dynamic ones that use symbols:One good way to organize custom matchers is to place them inside one or more traits that you can then mix into the suites or specs that need them. Here's an example that includes two
BePropertyMatcher
s:Because the type parameter of these two
BePropertyMatcher
s isjava.io.File
, they can only be used with instances of that type. (The compiler will enforce this.) All they do is create aBePropertyMatchResult
whosematches
field istrue
if and only if theBoolean
property istrue
. The second field,propertyName
, is simply the string name of the property. Thefile
anddirectory
val
s create variables that can be used in matcher expressions that test whether ajava.io.File
is a file or a directory. Here's an example:These matches should succeed, but if for example the first match,
tempFile should be a (file)
, were to fail, you would get an error message like:For more information on
BePropertyMatchResult
and the meaning of its fields, please see the documentation forBePropertyMatchResult
. To understand whyBePropertyMatcher
is contravariant in its type parameter, see the section entitled "Matcher's variance" in the documentation forMatcher
.