org.scalatest.matchers.Matchers
o != arg0
is the same as !(o == (arg0))
.
o != arg0
is the same as !(o == (arg0))
.
the object to compare against this object for dis-equality.
false
if the receiver object is equivalent to the argument; true
otherwise.
This method enables the following syntax:
This method enables the following syntax:
result should be < (7)
Note that the less than operator will be invoked on be
in this expression, not
on a result of passing be
to should
, as with most other operators
in the matchers DSL, because the less than operator has a higher precedence than should
.
Thus in the above case the first expression evaluated will be be < (7)
, which results
in a matcher that is passed to should
.
This method also enables the following syntax:
result should not (be < (7))
This method enables the following syntax:
This method enables the following syntax:
result should be <= (7)
Note that the less than or equal to operator will be invoked on be
in this expression, not
on a result of passing be
to should
, as with most other operators
in the matchers DSL, because the less than or equal to operator has a higher precedence than should
.
Thus in the above case the first expression evaluated will be be <= (7)
, which results
in a matcher that is passed to should
.
This method also enables the following syntax:
result should not (be <= (7))
o == arg0
is the same as if (o eq null) arg0 eq null else o.equals(arg0)
.
o == arg0
is the same as if (o eq null) arg0 eq null else o.equals(arg0)
.
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
o == arg0
is the same as o.equals(arg0)
.
o == arg0
is the same as o.equals(arg0)
.
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
This method enables the following syntax:
This method enables the following syntax:
result should be === (7)
Note that the === operator will be invoked on be
in this expression, not
on a result of passing be
to should
, as with most other operators
in the matchers DSL, because the ===n operator has a higher precedence than should
.
Thus in the above case the first expression evaluated will be be === (7)
, which results
in a matcher that is passed to should
.
This method also enables the following syntax:
result should not (be === (7))
This method enables the following syntax:
This method enables the following syntax:
result should be > (7)
Note that the greater than operator will be invoked on be
in this expression, not
on a result of passing be
to should
, as with most other operators
in the matchers DSL, because the greater than operator has a higher precedence than should
.
Thus in the above case the first expression evaluated will be be > (7)
, which results
in a matcher that is passed to should
.
This method also enables the following syntax:
result should not (be > (7))
This method enables the following syntax:
This method enables the following syntax:
result should be >= (7)
Note that the greater than or equal to operator will be invoked on be
in this expression, not
on a result of passing be
to should
, as with most other operators
in the matchers DSL, because the greater than or equal to operator has a higher precedence than should
.
Thus in the above case the first expression evaluated will be be >= (7)
, which results
in a matcher that is passed to should
.
This method also enables the following syntax:
result should not (be >= (7))
This method enables the following syntax, where fileMock
is, for example, of type File
andfile
refers to a BePropertyMatcher[File]
:
This method enables the following syntax, where fileMock
is, for example, of type File
andfile
refers to a BePropertyMatcher[File]
:
fileMock should not { be a (file) }
This method enables the following syntax:
This method enables the following syntax:
fileMock should not { be a ('file) }
This method enables the following syntax, where keyEvent
is, for example, of type KeyEvent
andactionKey
refers to a BePropertyMatcher[KeyEvent]
:
This method enables the following syntax, where keyEvent
is, for example, of type KeyEvent
andactionKey
refers to a BePropertyMatcher[KeyEvent]
:
keyEvent should not { be an (actionKey) }
This method enables the following syntax:
This method enables the following syntax:
animal should not { be an ('elephant) }
This method enables be
to be used for equality comparison.
This method enables be
to be used for equality comparison. Here are some examples:
object should be (None) object should be (Some(1)) result should be (true) result should be (false) sum should be (19)
This method enables the following syntax, where open
refers to a BePropertyMatcher
:
This method enables the following syntax, where open
refers to a BePropertyMatcher
:
door should be (open)
This method enables the following syntax, where num
is, for example, of type Int
andodd
refers to a BeMatcher[Int]
:
This method enables the following syntax, where num
is, for example, of type Int
andodd
refers to a BeMatcher[Int]
:
num should be (odd)
This method enables the following syntax:
This method enables the following syntax:
set should be ('empty)
This method enables the following syntax:
This method enables the following syntax:
object should be (null)
This method enables the following syntax:
This method enables the following syntax:
result should be (true)
This method enables the following syntax:
This method enables the following syntax:
sevenByte should be (7.toByte plusOrMinus 2.toByte)
This method enables the following syntax:
This method enables the following syntax:
sevenShort should be (7.toShort plusOrMinus 2.toShort)
This method enables the following syntax:
This method enables the following syntax:
sevenInt should be (7 plusOrMinus 2)
This method enables the following syntax:
This method enables the following syntax:
sevenLong should be (7L plusOrMinus 2L)
This method enables the following syntax:
This method enables the following syntax:
sevenDotOhFloat should be (7.1f plusOrMinus 0.2f)
This method enables the following syntax:
This method enables the following syntax:
sevenDotOh should be (7.1 plusOrMinus 0.2)
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.
the receiver object.
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
a copy of the receiver object.
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
).
the object to compare against this object for reference equality.
true
if the argument is a reference to the receiver object; false
otherwise.
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.
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 finalize
and non-local returns and exceptions, are all platform dependent.
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.
a representation that corresponds to the dynamic class of the receiver object.
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.
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.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
o.ne(arg0)
is the same as !(o.eq(arg0))
.
o.ne(arg0)
is the same as !(o.eq(arg0))
.
the object to compare against this object for reference dis-equality.
false
if the argument is not a reference to the receiver object; true
otherwise.
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.
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.
This method enables the following syntax:
This method enables the following syntax:
object should be theSameInstancreAs (anotherObject)
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.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
ShouldMatchers
orMustMatchers
for an overview of the matchers DSL.Class
BeWord
contains anapply
method that takes aSymbol
, which uses reflection to find and access aBoolean
property and determine if it istrue
. If the symbol passed is'empty
, for example, theapply
method will use reflection to look for a public Java field named "empty", a public method named "empty", or a public method named "isEmpty". If a field, it must be of typeBoolean
. If a method, it must take no parameters and returnBoolean
. If multiple candidates are found, theapply
method will select based on the following algorithm:TestFailedException
, because no candidates foundisEmpty()
isEmpty()
empty()
empty()
empty()
isEmpty()
empty()
(this can occur whenBeanProperty
annotation is used)empty
empty
empty
isEmpty()
isEmpty()
empty
empty()
empty()
empty
empty()
isEmpty()
empty()
(this can occur whenBeanProperty
annotation is used)authors:
Bill Venners