Matchers

Type Members

final class AWord extends AnyRef

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

This class is part of the ScalaTest matchers DSL.
final 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.
sealed class ResultOfHaveWordForJavaCollection[T] extends AnyRef

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

This class is part of the ScalaTest matchers DSL.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
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))
                   ^
```
Definition Classes
ClassicMatchers
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))
                   ^
```
Definition Classes
ClassicMatchers
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def ===(right: Any): ResultOfTripleEqualsApplication

This method enables the following syntax:
This method enables the following syntax:
```
num should not be === (10)
                  ^
```
Definition Classes
ClassicMatchers
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))
                   ^
```
Definition Classes
ClassicMatchers
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))
                   ^
```
Definition Classes
ClassicMatchers
val a: AWord

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

This field enables the following syntax:
This field enables the following syntax:
```
badBook should not be an (excellentRead)
                      ^
```
Definition Classes
ClassicMatchers
final def asInstanceOf[T0]: T0

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 String value 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 for Equalizer.
o
the Option[String] to assert

Definition Classes
Assertions
Exceptions thrown
TestFailedException
if the Option[String] is Some.
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 String value of the Some, as well as the String 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 for Equalizer.
o
the Option[String] to assert
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
Exceptions thrown
NullPointerException
if message is null.
TestFailedException
if the Option[String] is Some.
def assert(condition: Boolean, clue: Any): Unit

Assert that a boolean condition, described in String message, is true.
Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with the String 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
Exceptions thrown
NullPointerException
if message is null.
TestFailedException
if the condition is false.
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
Exceptions thrown
TestFailedException
if the condition is false.
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))
            ^
```
Definition Classes
ClassicMatchers
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
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))
             ^
```
Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
implicit def convertGetLengthFieldToIntLengthWrapper(o: AnyRef { val getLength: Int }): LengthWrapper

This implicit conversion method converts an object with a getLength field of type Int to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetLengthFieldToLongLengthWrapper(o: AnyRef { val getLength: Long }): LengthWrapper

This implicit conversion method converts an object with a getLength field of type Long to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetLengthMethodToIntLengthWrapper(o: AnyRef { def getLength(): Int }): LengthWrapper

This implicit conversion method converts an object with a getLength method of type Int to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetLengthMethodToLongLengthWrapper(o: AnyRef { def getLength(): Long }): LengthWrapper

This implicit conversion method converts an object with a getLength method of type Long to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetLengthParameterlessMethodToIntLengthWrapper(o: AnyRef { def getLength: Int }): LengthWrapper

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

Definition Classes
ClassicMatchers
implicit def convertGetLengthParameterlessMethodToLongLengthWrapper(o: AnyRef { def getLength: Long }): LengthWrapper

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

Definition Classes
ClassicMatchers
implicit def convertGetSizeFieldToIntSizeWrapper(o: AnyRef { val getSize: Int }): SizeWrapper

This implicit conversion method converts an object with a getSize field of type Int to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetSizeFieldToLongSizeWrapper(o: AnyRef { val getSize: Long }): SizeWrapper

This implicit conversion method converts an object with a getSize field of type Long to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetSizeMethodToIntSizeWrapper(o: AnyRef { def getSize(): Int }): SizeWrapper

This implicit conversion method converts an object with a getSize method of type Int to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetSizeMethodToLongSizeWrapper(o: AnyRef { def getSize(): Long }): SizeWrapper

This implicit conversion method converts an object with a getSize method of type Long to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertGetSizeParameterlessMethodToIntSizeWrapper(o: AnyRef { def getSize: Int }): SizeWrapper

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

Definition Classes
ClassicMatchers
implicit def convertGetSizeParameterlessMethodToLongSizeWrapper(o: AnyRef { def getSize: Long }): SizeWrapper

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

Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
implicit def convertLengthFieldToIntLengthWrapper(o: AnyRef { val length: Int }): LengthWrapper

This implicit conversion method converts an object with a length field of type Int to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertLengthFieldToLongLengthWrapper(o: AnyRef { val length: Long }): LengthWrapper

This implicit conversion method converts an object with a length field of type Long to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertLengthMethodToIntLengthWrapper(o: AnyRef { def length(): Int }): LengthWrapper

This implicit conversion method converts an object with a length method of type Int to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertLengthMethodToLongLengthWrapper(o: AnyRef { def length(): Long }): LengthWrapper

This implicit conversion method converts an object with a length method of type Long to a LengthWrapper, 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 a LengthWrapper, to enable that object to be used with the have length (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertLengthParameterlessMethodToIntLengthWrapper(o: AnyRef { def length: Int }): LengthWrapper

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

Definition Classes
ClassicMatchers
implicit def convertLengthParameterlessMethodToLongLengthWrapper(o: AnyRef { def length: Long }): LengthWrapper

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

Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
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]].
Definition Classes
ClassicMatchers
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.

Definition Classes
ClassicMatchers
implicit def convertSizeFieldToIntSizeWrapper(o: AnyRef { val size: Int }): SizeWrapper

This implicit conversion method converts an object with a size field of type Int to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertSizeFieldToLongSizeWrapper(o: AnyRef { val size: Long }): SizeWrapper

This implicit conversion method converts an object with a size field of type Long to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertSizeMethodToIntSizeWrapper(o: AnyRef { def size(): Int }): SizeWrapper

This implicit conversion method converts an object with a size method of type Int to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertSizeMethodToLongSizeWrapper(o: AnyRef { def size(): Long }): SizeWrapper

This implicit conversion method converts an object with a size method of type Long to a SizeWrapper, 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 a SizeWrapper, to enable that object to be used with the have size (7) syntax.

Definition Classes
ClassicMatchers
implicit def convertSizeParameterlessMethodToIntSizeWrapper(o: AnyRef { def size: Int }): SizeWrapper

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

Definition Classes
ClassicMatchers
implicit def convertSizeParameterlessMethodToLongSizeWrapper(o: AnyRef { def size: Long }): SizeWrapper

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

Definition Classes
ClassicMatchers
implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol): HavePropertyMatcherGenerator

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

Definition Classes
ClassicMatchers
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 Equalizer.
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 your Suite 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.

Definition Classes
Assertions
Exceptions thrown
NullPointerException
if left is null.
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.

Definition Classes
ClassicMatchers
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]].
Definition Classes
ClassicMatchers
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]].
Definition Classes
ClassicMatchers
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"))
               ^
```
Definition Classes
ClassicMatchers
final def eq(arg0: AnyRef): Boolean

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 left value, passing in the right value, on every type except arrays. If both left and right are arrays, deep will 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 the be theSameInstanceAs syntax.
Definition Classes
ClassicMatchers
def equals(arg0: Any): Boolean

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]
^
```
Definition Classes
ClassicMatchers
def expectResult(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 ==), expectResult returns normally. Else, expect throws a TestFailedException 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
Exceptions thrown
TestFailedException
if the passed actual value does not equal the passed expected value.
def expectResult(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 ==), expectResult returns normally. Else, if actual is not equal to expected, expectResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.
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
Exceptions thrown
TestFailedException
if the passed actual value does not equal the passed expected value.
def fail(cause: Throwable): Nothing

Throws TestFailedException, with the passed Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestFailedException will return cause.toString().
cause
a Throwable that indicates the cause of the failure.

Definition Classes
Assertions
Exceptions thrown
NullPointerException
if cause is null
def fail(message: String, cause: Throwable): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed String 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
Exceptions thrown
NullPointerException
if message or cause is null
def fail(message: String): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.
Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.
message
A message describing the failure.

Definition Classes
Assertions
Exceptions thrown
NullPointerException
if message is null
def fail(): Nothing

Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.

Definition Classes
Assertions
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
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))
               ^
```
Definition Classes
ClassicMatchers
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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'))
             ^
```
Definition Classes
ClassicMatchers
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"))
               ^
```
Definition Classes
ClassicMatchers
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 of AnyRef, 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
Exceptions thrown
TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type passed expected value.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: KeyWord

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

This field enables the following syntax:
This field enables the following syntax:
```
"hi" should not have length (3)
                     ^
```
Definition Classes
ClassicMatchers
final def ne(arg0: AnyRef): Boolean

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")))
               ^
```
Definition Classes
ClassicMatchers
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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]
^
```
Definition Classes
ClassicMatchers
val regex: RegexWord

This field enables the following syntax:
This field enables the following syntax:
```
"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
                              ^
```
Definition Classes
ClassicMatchers
val size: SizeWord

This field enables the following syntax:
This field enables the following syntax:
```
set should not have size (3)
                    ^
```
Definition Classes
ClassicMatchers
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"))
               ^
```
Definition Classes
ClassicMatchers
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val theSameInstanceAs: TheSameInstanceAsPhrase

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

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)
                       ^
```
Definition Classes
ClassicMatchers
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def withClue[T](clue: Any)(fun: ⇒ T): T

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
Exceptions thrown
NullPointerException
if the passed clue is null

Deprecated Value Members

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

This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with expectResult. The name expect will be used for a different purposes in a future version of ScalaTest.

Definition Classes
Assertions
Annotations
@deprecated
Deprecated
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
def expect(expected: Any, clue: Any)(actual: Any): Unit

This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with expectResult. The name expect will be used for a different purposes in a future version of ScalaTest.

Definition Classes
Assertions
Annotations
@deprecated
Deprecated
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.

trait Matchers extends ClassicMatchers

Type Members

final class AWord extends AnyRef

final class AnWord extends AnyRef

final class BeWord extends AnyRef

final class BytePlusOrMinusWrapper extends AnyRef

final case class ByteTolerance(right: Byte, tolerance: Byte) extends Product with Serializable

final class ContainWord extends AnyRef

final class DoublePlusOrMinusWrapper extends AnyRef

final case class DoubleTolerance(right: Double, tolerance: Double) extends Product with Serializable

final class EndWithWord extends AnyRef

final class Equalizer extends AnyRef

final class FloatPlusOrMinusWrapper extends AnyRef

final case class FloatTolerance(right: Float, tolerance: Float) extends Product with Serializable

final class FullyMatchWord extends AnyRef

final class HavePropertyMatcherGenerator extends AnyRef

final class HaveWord extends AnyRef

final class IncludeWord extends AnyRef

final class IntPlusOrMinusWrapper extends AnyRef

final case class IntTolerance(right: Int, tolerance: Int) extends Product with Serializable

final class KeyWord extends AnyRef

final class LengthWord extends AnyRef

abstract class LengthWrapper extends AnyRef

final class LongPlusOrMinusWrapper extends AnyRef

final case class LongTolerance(right: Long, tolerance: Long) extends Product with Serializable

final class MatcherWrapper[T] extends AnyRef

final class NotWord extends AnyRef

final class RegexWord extends AnyRef

final class ResultOfAWordToBePropertyMatcherApplication[T] extends AnyRef

final class ResultOfAWordToSymbolApplication extends AnyRef

final class ResultOfAnWordToBePropertyMatcherApplication[T] extends AnyRef

final class ResultOfAnWordToSymbolApplication extends AnyRef

final class ResultOfBeWordForAnyRef[T <: AnyRef] extends AnyRef

final class ResultOfContainWordForJavaMap[K, V] extends AnyRef

final class ResultOfContainWordForMap[K, V] extends AnyRef

final class ResultOfElementWordApplication[T] extends AnyRef

final class ResultOfEndWithWordForString extends AnyRef

final class ResultOfEvaluatingApplication extends AnyRef

final class ResultOfFullyMatchWordForString extends AnyRef

final class ResultOfGreaterThanComparison[T] extends AnyRef

final class ResultOfGreaterThanOrEqualToComparison[T] extends AnyRef

class ResultOfHaveWordForArray[T] extends AnyRef

sealed class ResultOfHaveWordForJavaCollection[T] extends AnyRef

final class ResultOfHaveWordForJavaList[T] extends ResultOfHaveWordForJavaCollection[T]

final class ResultOfHaveWordForJavaMap extends AnyRef

final class ResultOfHaveWordForLengthWrapper[A] extends AnyRef

final class ResultOfHaveWordForSeq[T] extends ResultOfHaveWordForTraversable[T]

final class ResultOfHaveWordForSizeWrapper[A] extends AnyRef

final class ResultOfHaveWordForString extends AnyRef

sealed class ResultOfHaveWordForTraversable[T] extends AnyRef

final class ResultOfIncludeWordForString extends AnyRef

final class ResultOfKeyWordApplication[T] extends AnyRef

final class ResultOfLengthWordApplication extends HavePropertyMatcher[AnyRef, Long]

final class ResultOfLessThanComparison[T] extends AnyRef

final class ResultOfLessThanOrEqualToComparison[T] extends AnyRef

sealed class ResultOfNotWord[T] extends AnyRef

sealed class ResultOfNotWordForAnyRef[T <: AnyRef] extends ResultOfNotWord[T]

final class ResultOfNotWordForArray[E] extends ResultOfNotWordForAnyRef[Array[E]]

final class ResultOfNotWordForByte extends ResultOfNotWord[Byte]

final class ResultOfNotWordForDouble extends ResultOfNotWord[Double]

final class ResultOfNotWordForFloat extends ResultOfNotWord[Float]

final class ResultOfNotWordForInt extends ResultOfNotWord[Int]

sealed class ResultOfNotWordForJavaCollection[E, T <: Collection[E]] extends ResultOfNotWordForAnyRef[T]

final class ResultOfNotWordForJavaList[E, T <: List[E]] extends ResultOfNotWordForJavaCollection[E, T]

final class ResultOfNotWordForJavaMap[K, V] extends ResultOfNotWordForAnyRef[Map[K, V]]

final class ResultOfNotWordForLengthWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

final class ResultOfNotWordForLong extends ResultOfNotWord[Long]

final class ResultOfNotWordForMap[K, V] extends ResultOfNotWordForTraversable[(K, V), Map[K, V]]

final class ResultOfNotWordForSeq[E, T <: Seq[E]] extends ResultOfNotWordForTraversable[E, T]

final class ResultOfNotWordForShort extends ResultOfNotWord[Short]

final class ResultOfNotWordForSizeWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

final class ResultOfNotWordForString extends ResultOfNotWordForAnyRef[String]

sealed class ResultOfNotWordForTraversable[E, T <: Traversable[E]] extends ResultOfNotWordForAnyRef[T]

final class ResultOfProduceInvocation[T] extends AnyRef

final class ResultOfRegexWordApplication extends AnyRef

final class ResultOfSizeWordApplication extends HavePropertyMatcher[AnyRef, Long]

final class ResultOfStartWithWordForString extends AnyRef

final class ResultOfTheSameInstanceAsApplication extends AnyRef

final class ResultOfTripleEqualsApplication extends AnyRef