org.scalatest.matchers.Matchers

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Matchers
Assertions
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Type Members

class AWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class AnWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class BeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class BytePlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class ByteTolerance (right: Byte, tolerance: Byte) extends Product

This class is part of the ScalaTest matchers DSL.
class ContainWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class DoublePlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class DoubleTolerance (right: Double, tolerance: Double) extends Product

This class is part of the ScalaTest matchers DSL.
class EndWithWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class Equalizer extends AnyRef

Class used via an implicit conversion to enable any two objects to be compared with=== in assertions in tests.
class FloatPlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class FloatTolerance (right: Float, tolerance: Float) extends Product

This class is part of the ScalaTest matchers DSL.
class FullyMatchWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class HavePropertyMatcherGenerator extends AnyRef

This class is part of the ScalaTest matchers DSL.
class HaveWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class IncludeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class IntPlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class IntTolerance (right: Int, tolerance: Int) extends Product

This class is part of the ScalaTest matchers DSL.
class KeyWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class LengthWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class LengthWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
class LongPlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class LongTolerance (right: Long, tolerance: Long) extends Product

This class is part of the ScalaTest matchers DSL.
class MatcherWrapper [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class NotWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class RegexWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfAWordToBePropertyMatcherApplication [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfAWordToSymbolApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfAnWordToBePropertyMatcherApplication [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfAnWordToSymbolApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfBeWordForAnyRef [T <: AnyRef] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfContainWordForJavaMap [K, V] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfContainWordForMap [K, V] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfElementWordApplication [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfEndWithWordForString extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfEvaluatingApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfFullyMatchWordForString extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfGreaterThanComparison [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfGreaterThanOrEqualToComparison [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForArray [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForJavaCollection [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForJavaList [T] extends ResultOfHaveWordForJavaCollection[T]

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForJavaMap extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForLengthWrapper [A] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForSeq [T] extends ResultOfHaveWordForTraversable[T]

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForSizeWrapper [A] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForString extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfHaveWordForTraversable [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfIncludeWordForString extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfKeyWordApplication [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfLengthWordApplication extends HavePropertyMatcher[AnyRef, Long]

This class is part of the ScalaTest matchers DSL.
class ResultOfLessThanComparison [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfLessThanOrEqualToComparison [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWord [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForAnyRef [T <: AnyRef] extends ResultOfNotWord[T]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForArray [E] extends ResultOfNotWordForAnyRef[Array[E]]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForByte extends ResultOfNotWord[Byte]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForDouble extends ResultOfNotWord[Double]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForFloat extends ResultOfNotWord[Float]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForInt extends ResultOfNotWord[Int]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForJavaCollection [E, T <: Collection[E]] extends ResultOfNotWordForAnyRef[T]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForJavaList [E, T <: List[E]] extends ResultOfNotWordForJavaCollection[E, T]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForJavaMap [K, V] extends ResultOfNotWordForAnyRef[Map[K, V]]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForLengthWrapper [A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForLong extends ResultOfNotWord[Long]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForMap [K, V] extends ResultOfNotWordForTraversable[(K, V), Map[K, V]]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForSeq [E, T <: Seq[E]] extends ResultOfNotWordForTraversable[E, T]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForShort extends ResultOfNotWord[Short]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForSizeWrapper [A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForString extends ResultOfNotWordForAnyRef[String]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForTraversable [E, T <: Traversable[E]] extends ResultOfNotWordForAnyRef[T]

This class is part of the ScalaTest matchers DSL.
class ResultOfProduceInvocation [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfRegexWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfSizeWordApplication extends HavePropertyMatcher[AnyRef, Long]

This class is part of the ScalaTest matchers DSL.
class ResultOfStartWithWordForString extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfTheSameInstanceAsApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfTripleEqualsApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ResultOfValueWordApplication [T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ShortPlusOrMinusWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
case class ShortTolerance (right: Short, tolerance: Short) extends Product

This class is part of the ScalaTest matchers DSL.
class SizeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class SizeWrapper extends AnyRef

This class is part of the ScalaTest matchers DSL.
class StartWithWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
class TheSameInstanceAsPhrase extends AnyRef

This class is part of the ScalaTest matchers DSL.
class ValueWord extends AnyRef

This class is part of the ScalaTest matchers DSL.

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def < [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfLessThanComparison[T]

This method enables the following syntax:
This method enables the following syntax:
```
num should (not be < (10) and not be > (17))
                   
```
def <= [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfLessThanOrEqualToComparison[T]

This method enables the following syntax:
This method enables the following syntax:
```
num should (not be <= (10) and not be > (17))
                   
```
def == (arg0: AnyRef) : Boolean

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).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def === (right: Any) : ResultOfTripleEqualsApplication

This method enables the following syntax:
This method enables the following syntax:
```
num should not be === (10)
                  
```
def > [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfGreaterThanComparison[T]

This method enables the following syntax:
This method enables the following syntax:
```
num should (not be > (10) and not be < (7))
                   
```
def >= [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfGreaterThanOrEqualToComparison[T]

This method enables the following syntax:
This method enables the following syntax:
```
num should (not be >= (10) and not be < (7))
                   
```
val a : AWord

This field enables the following syntax:
This field enables the following syntax:
```
badBook should not be a ('goodRead)
                      
```
val an : AnWord

This field enables the following syntax:
This field enables the following syntax:
```
badBook should not be an (excellentRead)
                      
```
def asInstanceOf [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.
returns
the receiver object.
attributes: final
definition classes: Any
def assert (o: Option[String]) : Unit

Assert that an Option[String] is None.
Assert that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestFailedException with the Stringvalue of the Some included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:
```
assert(a === b)
```
For more information on how this mechanism works, see the documentation forEqualizer.
o
the Option[String] to assert
definition classes: Assertions
def assert (o: Option[String], clue: Any) : Unit

Assert that an Option[String] is None.
Assert that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestFailedException with the Stringvalue of the Some, as well as theString obtained by invoking toString on the specified message, included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:
```
assert(a === b, "extra info reported if assertion fails")
```
For more information on how this mechanism works, see the documentation forEqualizer.
o
the Option[String] to assert
clue
An objects whose toString method returns a message to include in a failure report.
definition classes: Assertions
def assert (condition: Boolean, clue: Any) : Unit

Assert that a boolean condition, described in Stringmessage, is true.

Assert that a boolean condition, described in Stringmessage, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with theString obtained by invoking toString on the specified message as the exception's detail message.
condition
the boolean condition to assert
clue
An objects whose toString method returns a message to include in a failure report.
definition classes: Assertions
def assert (condition: Boolean) : Unit

Assert that a boolean condition is true.

Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.
condition
the boolean condition to assert
definition classes: Assertions
val be : BeWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
            
```
def clone () : AnyRef

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.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
val contain : ContainWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
list should (contain ('a') and have length (7))
             
```
implicit def convertByteToPlusOrMinusWrapper (right: Byte) : BytePlusOrMinusWrapper

Implicitly converts an object of type Byte to a BytePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Byte to a BytePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertDoubleToPlusOrMinusWrapper (right: Double) : DoublePlusOrMinusWrapper

Implicitly converts an object of type Double to a DoublePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Double to a DoublePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertFloatToPlusOrMinusWrapper (right: Float) : FloatPlusOrMinusWrapper

Implicitly converts an object of type Float to a FloatPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Float to a FloatPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertGetLengthFieldToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a getLength field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a getLength field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertGetLengthFieldToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a getLength field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a getLength field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertGetLengthMethodToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a getLength method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a getLength method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertGetLengthMethodToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a getLength method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a getLength method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertGetSizeFieldToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a getSize field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a getSize field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertGetSizeFieldToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a getSize field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a getSize field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertGetSizeMethodToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a getSize method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a getSize method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertGetSizeMethodToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a getSize method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a getSize method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertIntToPlusOrMinusWrapper (right: Int) : IntPlusOrMinusWrapper

Implicitly converts an object of type Int to a IntPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Int to a IntPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertLengthFieldToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a length field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a length field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertLengthFieldToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a length field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a length field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertLengthMethodToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a length method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a length method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertLengthMethodToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

This implicit conversion method converts an object with a length method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

This implicit conversion method converts an object with a length method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.
attributes: implicit
implicit def convertLongToPlusOrMinusWrapper (right: Long) : LongPlusOrMinusWrapper

Implicitly converts an object of type Long to a LongPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Long to a LongPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertMapMatcherToJavaMapMatcher [K, V] (mapMatcher: Matcher[Map[K, V]]) : Matcher[Map[K, V]]

This implicit conversion method enables the following syntax (javaMap is a java.util.Map):
This implicit conversion method enables the following syntax (javaMap is a java.util.Map):
```
javaMap should (contain key ("two"))
```
The (contain key ("two")) expression will result in a Matcher[scala.collection.Map[String, Any]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Map[String, Any]].
attributes: implicit
implicit def convertShortToPlusOrMinusWrapper (right: Short) : ShortPlusOrMinusWrapper

Implicitly converts an object of type Short to a ShortPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

Implicitly converts an object of type Short to a ShortPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.
attributes: implicit
implicit def convertSizeFieldToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a size field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a size field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertSizeFieldToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a size field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a size field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertSizeMethodToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a size method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a size method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertSizeMethodToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

This implicit conversion method converts an object with a size method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

This implicit conversion method converts an object with a size method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.
attributes: implicit
implicit def convertSymbolToHavePropertyMatcherGenerator (symbol: Symbol) : HavePropertyMatcherGenerator

This implicit conversion method converts a Symbol to aHavePropertyMatcherGenerator, to enable the symbol to be used with the have ('author ("Dickens")) syntax.

This implicit conversion method converts a Symbol to aHavePropertyMatcherGenerator, to enable the symbol to be used with the have ('author ("Dickens")) syntax.
attributes: implicit
implicit def convertToEqualizer (left: Any) : Equalizer

Implicit conversion from Any to Equalizer, used to enable assertions with === comparisons.
Implicit conversion from Any to Equalizer, used to enable assertions with === comparisons.
For more information on this mechanism, see the documentation for </code>Equalizer</code>.
Because trait Suite mixes in Assertions, this implicit conversion will always be available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator, you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off the implicit conversion offered by this convertToEqualizer method simply by overriding the method in yourSuite subclass, but not marking it as implicit:
```
// In your Suite subclass
override def convertToEqualizer(left: Any) = new Equalizer(left)
```
left
the object whose type to convert to Equalizer.
attributes: implicit
definition classes: Assertions
implicit def convertToMatcherWrapper [T] (leftMatcher: Matcher[T]) : MatcherWrapper[T]

This implicit conversion method enables ScalaTest matchers expressions that involve and and or.

This implicit conversion method enables ScalaTest matchers expressions that involve and and or.
attributes: implicit
implicit def convertTraversableMatcherToArrayMatcher [T] (traversableMatcher: Matcher[Traversable[T]]) : Matcher[Array[T]]

This implicit conversion method enables the following syntax:
This implicit conversion method enables the following syntax:
```
Array(1, 2) should (not contain (3) and not contain (2))
```
The (not contain ("two")) expression will result in a Matcher[Traversable[String]]. This implicit conversion method will convert that matcher to a Matcher[Array[String]].
attributes: implicit
implicit def convertTraversableMatcherToJavaCollectionMatcher [T] (traversableMatcher: Matcher[Traversable[T]]) : Matcher[Collection[T]]

This implicit conversion method enables the following syntax (javaColl is a java.util.Collection):
This implicit conversion method enables the following syntax (javaColl is a java.util.Collection):
```
javaColl should contain ("two")
```
The (contain ("two")) expression will result in a Matcher[Traversable[String]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Collection[String]].
attributes: implicit
val endWith : EndWithWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
string should (endWith ("ago") and include ("score"))
               
```
def eq (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
def equal (right: Any) : Matcher[Any]

This method enables the following syntax:
This method enables the following syntax:
```
result should equal (7)
              
```
The left should equal (right) syntax works by calling == on the leftvalue, passing in the right value, on every type except arrays. If both left and right are arrays, deepwill be invoked on both left and right before comparing them with ==. Thus, even though this expression will yield false, because Array's equals method compares object identity:
```
Array(1, 2) == Array(1, 2) // yields false
```
The following expression will not result in a TestFailedException, because ScalaTest will compare the two arrays structurally, taking into consideration the equality of the array's contents:
```
Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)
```
If you ever do want to verify that two arrays are actually the same object (have the same identity), you can use thebe theSameInstanceAs syntax.
def equals (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
def evaluating (fun: ⇒ Any) : ResultOfEvaluatingApplication

This method enables syntax such as the following:
This method enables syntax such as the following:
```
evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException]
```
def expect (expected: Any)(actual: Any) : Unit

Expect that the value passed as expected equals the value passed as actual.

Expect that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), expect returns normally. Else, expect throws anTestFailedException whose detail message includes the expected and actual values.
expected
the expected value
actual
the actual value, which should equal the passed expected value
definition classes: Assertions
def expect (expected: Any, clue: Any)(actual: Any) : Unit

Expect that the value passed as expected equals the value passed as actual.

Expect that the value passed as expected equals the value passed as actual. If the actual equals the expected(as determined by ==), expect returns normally. Else, if actual is not equal to expected, expect throws anTestFailedException whose detail message includes the expected and actual values, as well as the Stringobtained by invoking toString on the passed message.
expected
the expected value
clue
An object whose toString method returns a message to include in a failure report.
actual
the actual value, which should equal the passed expected value
definition classes: Assertions
def fail (cause: Throwable) : Nothing

Throws TestFailedException, with the passedThrowable cause, to indicate a test failed.

Throws TestFailedException, with the passedThrowable cause, to indicate a test failed. The getMessage method of the thrown TestFailedExceptionwill return cause.toString().
cause
a Throwable that indicates the cause of the failure.
definition classes: Assertions
def fail (message: String, cause: Throwable) : Nothing

Throws TestFailedException, with the passedString message as the exception's detail message and Throwable cause, to indicate a test failed.

Throws TestFailedException, with the passedString message as the exception's detail message and Throwable cause, to indicate a test failed.
message
A message describing the failure.
cause
A Throwable that indicates the cause of the failure.
definition classes: Assertions
def fail (message: String) : Nothing

Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.

Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.
message
A message describing the failure.
definition classes: Assertions
def fail () : Nothing

Throws TestFailedException to indicate a test failed.

Throws TestFailedException to indicate a test failed.
definition classes: Assertions
def finalize () : 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
val fullyMatch : FullyMatchWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99))
               
```
def getClass () : 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
def hashCode () : 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
val have : HaveWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
list should (have length (3) and not contain ('a'))
             
```
val include : IncludeWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
string should (include ("hope") and not startWith ("no"))
               
```
def intercept [T <: AnyRef] (f: ⇒ Any)(implicit manifest: Manifest[T]) : T

Intercept and return an exception that's expected to be thrown by the passed function value.

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.
Note that the type specified as this method's type parameter may represent any subtype ofAnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.
f
the function value that should throw the expected exception
manifest
an implicit Manifest representing the type of the specified type parameter.
returns
the intercepted exception, if it is of the expected type
definition classes: Assertions
def isInstanceOf [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
val key : KeyWord

This field enables the following syntax:
This field enables the following syntax:
```
map should not contain key (10)
                       
```
val length : LengthWord

This field enables the following syntax:
This field enables the following syntax:
```
"hi" should not have length (3)
                     
```
def ne (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
val not : NotWord

This field enables syntax like the following:
This field enables syntax like the following:
```
myFile should (not be an (directory) and not have ('name ("foo.bar")))
               
```
def notify () : 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
def notifyAll () : 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.
attributes: final
definition classes: AnyRef
def produce [T] (implicit manifest: Manifest[T]) : ResultOfProduceInvocation[T]

This method enables the following syntax:
This method enables the following syntax:
```
evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException]
```

val regex : RegexWord

This field enables the following syntax:

"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)

val size : SizeWord

This field enables the following syntax:
This field enables the following syntax:
```
set should not have size (3)
                    
```
val startWith : StartWithWord

This method enables syntax such as the following:
This method enables syntax such as the following:
```
string should (startWith ("Four") and include ("year"))
               
```
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
val theSameInstanceAs : TheSameInstanceAsPhrase

This field enables the following syntax:
This field enables the following syntax:
```
oneString should not be theSameInstanceAs (anotherString)
                        
```
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
val value : ValueWord

This field enables the following syntax:
This field enables the following syntax:
```
map should not contain value (10)
                       
```
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef
def withClue (clue: Any)(fun: ⇒ Unit) : Unit

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it.
Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).
This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
```
withClue("(Employee's name was: " + employee.name + ")") {
  intercept[IllegalArgumentException] {
    employee.getTask(-1)
  }
}
```
If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:
```
(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
```
definition classes: Assertions

Matchers

trait Matchers extends Assertions

Type Members

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def < [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfLessThanComparison[T]

def <= [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfLessThanOrEqualToComparison[T]

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

def === (right: Any) : ResultOfTripleEqualsApplication

def > [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfGreaterThanComparison[T]

def >= [T] (right: T)(implicit arg0: (T) ⇒ Ordered[T]) : ResultOfGreaterThanOrEqualToComparison[T]

val a : AWord

val an : AnWord

def asInstanceOf [T0] : T0

def assert (o: Option[String]) : Unit

def assert (o: Option[String], clue: Any) : Unit

def assert (condition: Boolean, clue: Any) : Unit

def assert (condition: Boolean) : Unit

val be : BeWord

def clone () : AnyRef

val contain : ContainWord

implicit def convertByteToPlusOrMinusWrapper (right: Byte) : BytePlusOrMinusWrapper

implicit def convertDoubleToPlusOrMinusWrapper (right: Double) : DoublePlusOrMinusWrapper

implicit def convertFloatToPlusOrMinusWrapper (right: Float) : FloatPlusOrMinusWrapper

implicit def convertGetLengthFieldToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertGetLengthFieldToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertGetLengthMethodToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertGetLengthMethodToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertGetSizeFieldToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertGetSizeFieldToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertGetSizeMethodToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertGetSizeMethodToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertIntToPlusOrMinusWrapper (right: Int) : IntPlusOrMinusWrapper

implicit def convertLengthFieldToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertLengthFieldToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertLengthMethodToIntLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertLengthMethodToLongLengthWrapper (o: AnyRef {...}) : LengthWrapper

implicit def convertLongToPlusOrMinusWrapper (right: Long) : LongPlusOrMinusWrapper

implicit def convertMapMatcherToJavaMapMatcher [K, V] (mapMatcher: Matcher[Map[K, V]]) : Matcher[Map[K, V]]

implicit def convertShortToPlusOrMinusWrapper (right: Short) : ShortPlusOrMinusWrapper

implicit def convertSizeFieldToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertSizeFieldToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertSizeMethodToIntSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertSizeMethodToLongSizeWrapper (o: AnyRef {...}) : SizeWrapper

implicit def convertSymbolToHavePropertyMatcherGenerator (symbol: Symbol) : HavePropertyMatcherGenerator

implicit def convertToEqualizer (left: Any) : Equalizer

implicit def convertToMatcherWrapper [T] (leftMatcher: Matcher[T]) : MatcherWrapper[T]

implicit def convertTraversableMatcherToArrayMatcher [T] (traversableMatcher: Matcher[Traversable[T]]) : Matcher[Array[T]]

implicit def convertTraversableMatcherToJavaCollectionMatcher [T] (traversableMatcher: Matcher[Traversable[T]]) : Matcher[Collection[T]]

val endWith : EndWithWord

def eq (arg0: AnyRef) : Boolean

def equal (right: Any) : Matcher[Any]

def equals (arg0: Any) : Boolean

def evaluating (fun: ⇒ Any) : ResultOfEvaluatingApplication

def expect (expected: Any)(actual: Any) : Unit

def expect (expected: Any, clue: Any)(actual: Any) : Unit

def fail (cause: Throwable) : Nothing

def fail (message: String, cause: Throwable) : Nothing

def fail (message: String) : Nothing

def fail () : Nothing