org.scalatest.matchers.ShouldMatchers

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

ShouldMatchers
ShouldMatchers
ShouldVerb
Matchers
ClassicMatchers
Assertions
AnyRef
Any

Visibility

Public
All

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 AnyRefShouldWrapper [T <: AnyRef] extends AnyRef

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

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

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

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.
class DoubleShouldWrapper extends AnyRef

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

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 EvaluatingApplicationShouldWrapper extends AnyRef

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

Sealed supertrait for Length and Size type classes.
class FloatPlusOrMinusWrapper extends AnyRef

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

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

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.
class IntShouldWrapper extends AnyRef

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

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

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

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

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

This class is part of the ScalaTest matchers DSL.
trait Length [T] extends Extent[T]

Supertrait for Length type classes.
class LengthWord extends AnyRef

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

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

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

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

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

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 ResultOfHaveWordForExtent [A] 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 ResultOfHaveWordForSeq [T] extends ResultOfHaveWordForTraversable[T]

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 ResultOfNotWordForLength [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), GenMap[K, V]]

This class is part of the ScalaTest matchers DSL.
class ResultOfNotWordForSeq [E, T <: GenSeq[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 ResultOfNotWordForSize [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 <: GenTraversable[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 SeqShouldWrapper [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.
class ShortShouldWrapper extends AnyRef

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

This class is part of the ScalaTest matchers DSL.
trait Size [T] extends Extent[T]

Supertrait for Size type classes.
class SizeWord 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 StringShouldWrapper extends StringShouldWrapperForVerb

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

This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
class TheSameInstanceAsPhrase extends AnyRef

This class is part of the ScalaTest matchers DSL.
class TraversableShouldWrapper [T] 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

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
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
def == (arg0: AnyRef): Boolean

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

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)
                  ^
```
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
def asInstanceOf [T0] : T0

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 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
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 clue, 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
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 clue 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
def assume (o: Option[String]): Unit

Assume that an Option[String] is None.
Assume that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestCanceledException with the String value of the Some included in the TestCanceledException's detail message.
This form of assume 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
def assume (o: Option[String], clue: Any): Unit

Assume that an Option[String] is None.
Assume that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestCanceledException with the String value of the Some, as well as the String obtained by invoking toString on the specified clue, included in the TestCanceledException's detail message.
This form of assume is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:
```
assume(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
def assume (condition: Boolean, clue: Any): Unit

Assume that a boolean condition, described in String message, is true.
Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with the String obtained by invoking toString on the specified clue as the exception's detail message.
condition
the boolean condition to assume
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
def assume (condition: Boolean): Unit

Assume that a boolean condition is true.
Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.
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))
            ^
```
Definition Classes
ClassicMatchers
def cancel (cause: Throwable): Nothing

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.
cause
a Throwable that indicates the cause of the cancellation.

Definition Classes
Assertions
def cancel (message: String, cause: Throwable): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.
Throws TestCanceledException, 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
def cancel (message: String): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.
Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.
message
A message describing the cancellation.

Definition Classes
Assertions
def cancel (): Nothing

Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.

Definition Classes
Assertions
def clone (): AnyRef

Attributes
protected[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.

Attributes
implicit
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.

Attributes
implicit
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.

Attributes
implicit
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.

Attributes
implicit
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.

Attributes
implicit
Definition Classes
ClassicMatchers
implicit def convertMapMatcherToJavaMapMatcher [K, V] (mapMatcher: Matcher[GenMap[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.GenMap[String, Any]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Map[String, Any]].
Attributes
implicit
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.

Attributes
implicit
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.

Attributes
implicit
Definition Classes
ClassicMatchers
implicit def convertToAnyRefShouldWrapper [T <: AnyRef] (o: T): AnyRefShouldWrapper[T]

Implicitly converts a scala.AnyRef of type T to an AnyRefShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts a scala.AnyRef of type T to an AnyRefShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToAnyShouldWrapper [T] (o: T): AnyShouldWrapper[T]

Implicitly converts an object of type T to a AnyShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type T to a AnyShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToArrayShouldWrapper [T] (o: Array[T]): ArrayShouldWrapper[T]

Implicitly converts an object of type scala.Array[T] to a ArrayShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Array[T] to a ArrayShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToByteShouldWrapper (o: Byte): ByteShouldWrapper

Implicitly converts an object of type scala.Byte to a ByteShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Byte to a ByteShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToDoubleShouldWrapper (o: Double): DoubleShouldWrapper

Implicitly converts an object of type scala.Double to a DoubleShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Double to a DoubleShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
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.

Attributes
implicit
Definition Classes
Assertions
implicit def convertToEvaluatingApplicationShouldWrapper (o: ResultOfEvaluatingApplication): EvaluatingApplicationShouldWrapper

Implicitly converts an object of type T to a EvaluatingApplicationShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type T to a EvaluatingApplicationShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToFloatShouldWrapper (o: Float): FloatShouldWrapper

Implicitly converts an object of type scala.Float to a FloatShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Float to a FloatShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToIntShouldWrapper (o: Int): IntShouldWrapper

Implicitly converts an object of type scala.Int to a IntShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Int to a IntShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToJavaCollectionShouldWrapper [T] (o: Collection[T]): JavaCollectionShouldWrapper[T]

Implicitly converts an object of type java.util.Collection[T] to a JavaCollectionShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type java.util.Collection[T] to a JavaCollectionShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToJavaListShouldWrapper [T] (o: List[T]): JavaListShouldWrapper[T]

Implicitly converts an object of type java.util.List[T] to a JavaListShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type java.util.List[T] to a JavaListShouldWrapper[T], to enable should methods to be invokable on that object. This conversion is necessary to enable length to be used on Java Lists.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToJavaMapShouldWrapper [K, V] (o: Map[K, V]): JavaMapShouldWrapper[K, V]

Implicitly converts an object of type java.util.Map[K, V] to a JavaMapShouldWrapper[K, V], to enable should methods to be invokable on that object.
Implicitly converts an object of type java.util.Map[K, V] to a JavaMapShouldWrapper[K, V], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToListShouldWrapper [T] (o: List[T]): ListShouldWrapper[T]

Implicitly converts an object of type scala.List[T] to a ListShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.List[T] to a ListShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToLongShouldWrapper (o: Long): LongShouldWrapper

Implicitly converts an object of type scala.Long to a LongShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Long to a LongShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToMapShouldWrapper [K, V] (o: GenMap[K, V]): MapShouldWrapper[K, V]

Implicitly converts an object of type scala.collection.GenMap[K, V] to a MapShouldWrapper[K, V], to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.collection.GenMap[K, V] to a MapShouldWrapper[K, V], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
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
Definition Classes
ClassicMatchers
implicit def convertToSeqShouldWrapper [T] (o: GenSeq[T]): SeqShouldWrapper[T]

Implicitly converts an object of type GenSeq[T] to a SeqShouldWrapper[T], to enable should methods to be invokable on that object.
Implicitly converts an object of type GenSeq[T] to a SeqShouldWrapper[T], to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToShortShouldWrapper (o: Short): ShortShouldWrapper

Implicitly converts an object of type scala.Short to a ShortShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Short to a ShortShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertToStringShouldWrapper (o: String): StringShouldWrapper

Implicitly converts an object of type java.lang.String to a StringShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type java.lang.String to a StringShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers → ShouldVerb
implicit def convertToTraversableShouldWrapper [T] (o: GenTraversable[T]): TraversableShouldWrapper[T]

Implicitly converts an object of type scala.Collection[T] to a CollectionShouldWrapper, to enable should methods to be invokable on that object.
Implicitly converts an object of type scala.Collection[T] to a CollectionShouldWrapper, to enable should methods to be invokable on that object.

Attributes
implicit
Definition Classes
ShouldMatchers
implicit def convertTraversableMatcherToArrayMatcher [T] (traversableMatcher: Matcher[GenTraversable[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[GenTraversable[String]]. This implicit conversion method will convert that matcher to a Matcher[Array[String]].
Attributes
implicit
Definition Classes
ClassicMatchers
implicit def convertTraversableMatcherToJavaCollectionMatcher [T] (traversableMatcher: Matcher[GenTraversable[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[GenTraversable[String]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Collection[String]].
Attributes
implicit
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
def eq (arg0: AnyRef): Boolean

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 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
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
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
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
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
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[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
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
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
def isInstanceOf [T0] : Boolean

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)
                       ^
```
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
def ne (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

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]
^
```
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
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)
                        ^
```
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
def wait (): Unit

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

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

Attributes
final
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
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.

ShouldMatchers

object ShouldMatchers extends ShouldMatchers

Type Members

class AWord extends AnyRef

class AnWord extends AnyRef

class AnyRefShouldWrapper [T <: AnyRef] extends AnyRef

class AnyShouldWrapper [T] extends AnyRef

class ArrayShouldWrapper [T] extends AnyRef

class BeWord extends AnyRef

class BytePlusOrMinusWrapper extends AnyRef

class ByteShouldWrapper extends AnyRef

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

class ContainWord extends AnyRef

class DoublePlusOrMinusWrapper extends AnyRef

class DoubleShouldWrapper extends AnyRef

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

class EndWithWord extends AnyRef

class Equalizer extends AnyRef

class EvaluatingApplicationShouldWrapper extends AnyRef

trait Extent [T] extends AnyRef

class FloatPlusOrMinusWrapper extends AnyRef

class FloatShouldWrapper extends AnyRef

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

class FullyMatchWord extends AnyRef

class HavePropertyMatcherGenerator extends AnyRef

class HaveWord extends AnyRef

class IncludeWord extends AnyRef

class IntPlusOrMinusWrapper extends AnyRef

class IntShouldWrapper extends AnyRef

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

class JavaCollectionShouldWrapper [T] extends AnyRef

class JavaListShouldWrapper [T] extends AnyRef

class JavaMapShouldWrapper [K, V] extends AnyRef

class KeyWord extends AnyRef

trait Length [T] extends Extent[T]

class LengthWord extends AnyRef

class ListShouldWrapper [T] extends AnyRef

class LongPlusOrMinusWrapper extends AnyRef

class LongShouldWrapper extends AnyRef

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

class MapShouldWrapper [K, V] extends AnyRef

class MatcherWrapper [T] extends AnyRef

class NotWord extends AnyRef

class RegexWord extends AnyRef

class ResultOfAWordToBePropertyMatcherApplication [T] extends AnyRef

class ResultOfAWordToSymbolApplication extends AnyRef

class ResultOfAnWordToBePropertyMatcherApplication [T] extends AnyRef

class ResultOfAnWordToSymbolApplication extends AnyRef

class ResultOfBeWordForAnyRef [T <: AnyRef] extends AnyRef

class ResultOfContainWordForJavaMap [K, V] extends AnyRef

class ResultOfContainWordForMap [K, V] extends AnyRef

class ResultOfElementWordApplication [T] extends AnyRef

class ResultOfEndWithWordForString extends AnyRef

class ResultOfEvaluatingApplication extends AnyRef

class ResultOfFullyMatchWordForString extends AnyRef

class ResultOfGreaterThanComparison [T] extends AnyRef

class ResultOfGreaterThanOrEqualToComparison [T] extends AnyRef

class ResultOfHaveWordForArray [T] extends AnyRef

class ResultOfHaveWordForExtent [A] extends AnyRef

class ResultOfHaveWordForJavaCollection [T] extends AnyRef

class ResultOfHaveWordForJavaList [T] extends ResultOfHaveWordForJavaCollection[T]

class ResultOfHaveWordForJavaMap extends AnyRef

class ResultOfHaveWordForSeq [T] extends ResultOfHaveWordForTraversable[T]

class ResultOfHaveWordForString extends AnyRef

class ResultOfHaveWordForTraversable [T] extends AnyRef

class ResultOfIncludeWordForString extends AnyRef

class ResultOfKeyWordApplication [T] extends AnyRef

class ResultOfLengthWordApplication extends HavePropertyMatcher[AnyRef, Long]

class ResultOfLessThanComparison [T] extends AnyRef

class ResultOfLessThanOrEqualToComparison [T] extends AnyRef

class ResultOfNotWord [T] extends AnyRef

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

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

class ResultOfNotWordForByte extends ResultOfNotWord[Byte]

class ResultOfNotWordForDouble extends ResultOfNotWord[Double]

class ResultOfNotWordForFloat extends ResultOfNotWord[Float]

class ResultOfNotWordForInt extends ResultOfNotWord[Int]

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

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

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