org.scalatest.matchers.ShouldMatchers

Trait that provides a domain specific language (DSL) for expressing assertions in tests using the word should. (If you prefer the word must, you can alternatively mix in trait MustMatchers.) For example, if you mix ShouldMatchers into a suite class, you can write an equality assertion in that suite like this:

result should equal (3)

Here result is a variable, and can be of any type. If the object is an Int with the value 3, execution will continue (i.e., the expression will result in the unit value, ()). Otherwise, a TestFailedException will be thrown with a detail message that explains the problem, such as "7 did not equal 3". This TestFailedException will cause the test to fail.

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 compares 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, described below.

Checking size and length

You can check the size or length of just about any type of object for which it would make sense. Here's how checking for length looks:

result should have length (3)

Size is similar:

result should have size (10)

The length syntax can be used with String, Array, any scala.collection.GenSeq, any java.util.List, and any type T for which an implicit Length[T] type class is available in scope. Similarly, the size syntax can be used with Array, any scala.collection.GenTraversable, any java.util.List, and any type T for which an implicit Size[T] type class is available in scope. You can enable the length or size syntax for your own arbitrary types, therefore, by defining Length or Size type classes for those types.

Checking strings

You can check for whether a string starts with, ends with, or includes a substring like this:

string should startWith ("Hello")
string should endWith ("world")
string should include ("seven")

You can check for whether a string starts with, ends with, or includes a regular expression, like this:

string should startWith regex ("Hel*o")
string should endWith regex ("wo.ld")
string should include regex ("wo.ld")

And you can check whether a string fully matches a regular expression, like this:

string should fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")

The regular expression passed following the regex token can be either a String or a scala.util.matching.Regex.

Greater and less than

You can check whether any type that is, or can be implicitly converted to, an Ordered[T] is greater than, less than, greater than or equal, or less than or equal to a value of type T. The syntax is:

one should be < (7)
one should be > (0)
one should be <= (7)
one should be >= (0)

Checking equality with `be` `===`

An alternate way to check for equality of two objects is to use be with ===. Here's an example:

result should be === (3)

Here result is a variable, and can be of any type. If the object is an Int with the value 3, execution will continue (i.e., the expression will result in the unit value, ()). Otherwise, a TestFailedException will be thrown with a detail message that explains the problem, such as "7 was not equal to 3". This TestFailedException will cause the test to fail.

The left should be === (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 compares the two arrays structurally, taking into consideration the equality of the array's contents:

Array(1, 2) should be === (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, described below.

Checking `Boolean` properties with `be`

If an object has a method that takes no parameters and returns boolean, you can check it by placing a Symbol (after be) that specifies the name of the method (excluding an optional prefix of "is"). A symbol literal in Scala begins with a tick mark and ends at the first non-identifier character. Thus, 'empty results in a Symbol object at runtime, as does 'defined and 'file. Here's an example:

emptySet should be ('empty)

Given this code, ScalaTest will use reflection to look on the object referenced from emptySet for a method that takes no parameters and results in Boolean, with either the name empty or isEmpty. If found, it will invoke that method. If the method returns true, execution will continue. But if it returns false, a TestFailedException will be thrown that will contain a detail message, such as:

Set(1, 2, 3) was not empty

This be syntax can be used with any type. If the object does not have an appropriately named predicate method, you'll get a TestFailedException at runtime with a detail message that explains the problem. (For the details on how a field or method is selected during this process, see the documentation for BeWord.)

If you think it reads better, you can optionally put a or an after be. For example, java.io.File has two predicate methods, isFile and isDirectory. Thus with a File object named temp, you could write:

temp should be a ('file)

Or, given java.awt.event.KeyEvent has a method isActionKey that takes no arguments and returns Boolean, you could assert that a KeyEvent is an action key with:

keyEvent should be an ('actionKey)

If you prefer to check Boolean properties in a type-safe manner, you can use a BePropertyMatcher. This would allow you to write expressions such as:

emptySet should be (empty)
temp should be a (file)
keyEvent should be an (actionKey)

These expressions would fail to compile if should is used on an inappropriate type, as determined by the type parameter of the BePropertyMatcher being used. (For example, file in this example would likely be of type BePropertyMatcher[java.io.File]. If used with an appropriate type, such an expression will compile and at run time the Boolean property method or field will be accessed directly; i.e., no reflection will be used. See the documentation for BePropertyMatcher for more information.

Using custom `BeMatchers`

If you want to create a new way of using be, which doesn't map to an actual property on the type you care about, you can create a BeMatcher. You could use this, for example, to create BeMatcher[Int] called odd, which would match any odd Int, and even, which would match any even Int. Given this pair of BeMatchers, you could check whether an Int was odd or even with expressions like:

num should be (odd)
num should not be (even)

For more information, see the documentation for BeMatcher.

Checking object identity

If you need to check that two references refer to the exact same object, you can write:

ref1 should be theSameInstanceAs (ref2)

Checking numbers against a range

To check whether a floating point number has a value that exactly matches another, you can use should equal:

sevenDotOh should equal (7.0)

Often, however, you may want to check whether a floating point number is within a range. You can do that using be and plusOrMinus, like this:

sevenDotOh should be (6.9 plusOrMinus 0.2)

This expression will cause a TestFailedException to be thrown if the floating point value, sevenDotOh is outside the range 6.7 to 7.1. You can also use plusOrMinus with integral types, for example:

seven should be (6 plusOrMinus 2)

Traversables, iterables, sets, sequences, and maps

You can use some of the syntax shown previously with Iterable and its subtypes. For example, you can check whether an Iterable is empty, like this:

iterable should be ('empty)

You can check the length of an Seq (Array, List, etc.), like this:

array should have length (3)
list should have length (9)

You can check the size of any Traversable, like this:

map should have size (20)
set should have size (90)

In addition, you can check whether an Iterable contains a particular element, like this:

iterable should contain ("five")

You can also check whether a Map contains a particular key, or value, like this:

map should contain key (1)
map should contain value ("Howdy")

Java collections and maps

You can use similar syntax on Java collections (java.util.Collection) and maps (java.util.Map). For example, you can check whether a Java Collection or Map is empty, like this:

javaCollection should be ('empty)
javaMap should be ('empty)

Even though Java's List type doesn't actually have a length or getLength method, you can nevertheless check the length of a Java List (java.util.List) like this:

javaList should have length (9)

You can check the size of any Java Collection or Map, like this:

javaMap should have size (20)
javaSet should have size (90)

In addition, you can check whether a Java Collection contains a particular element, like this:

javaCollection should contain ("five")

One difference to note between the syntax supported on Java collections and that of Scala iterables is that you can't use contain (...) syntax with a Java Map. Java differs from Scala in that its Map is not a subtype of its Collection type. If you want to check that a Java Map contains a specific key/value pair, the best approach is to invoke entrySet on the Java Map and check that entry set for the appropriate element (a java.util.Map.Entry) using contain (...).

Despite this difference, the other (more commonly used) map matcher syntax works just fine on Java Maps. You can, for example, check whether a Java Map contains a particular key, or value, like this:

javaMap should contain key (1)
javaMap should contain value ("Howdy")

Be as an equality comparison

All uses of be other than those shown previously perform an equality comparison. In other words, they work the same as equals. This redundance between be and equals exists because it enables syntax that sometimes sounds more natural. For example, instead of writing:

result should equal (null)

You can write:

result should be (null)

(Hopefully you won't write that too much given null is error prone, and Option is usually a better, well, option.) Here are some other examples of be used for equality comparison:

sum should be (7.0)
boring should be (false)
fun should be (true)
list should be (Nil)
option should be (None)
option should be (Some(1))

As with equal, using be on two arrays results in deep being called on both arrays prior to calling equal. As a result, the following expression would not throw a TestFailedException:

Array(1, 2) should be (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)

Because be is used in several ways in ScalaTest matcher syntax, just as it is used in many ways in English, one potential point of confusion in the event of a failure is determining whether be was being used as an equality comparison or in some other way, such as a property assertion. To make it more obvious when be is being used for equality, the failure messages generated for those equality checks will include the word equal in them. For example, if this expression fails with a TestFailedException:

option should be (Some(1))

The detail message in that TestFailedException will include the words "equal to" to signify be was in this case being used for equality comparison:

Some(2) was not equal to Some(1)

Being negative

If you wish to check the opposite of some condition, you can simply insert not in the expression. Here are a few examples:

result should not be (null)
sum should not be <= (10)
mylist should not equal (yourList)
string should not startWith ("Hello")

Logical expressions with `and` and `or`

You can also combine matcher expressions with and and/or or, however, you must place parentheses or curly braces around the and or or expression. For example, this and-expression would not compile, because the parentheses are missing:

map should contain key ("two") and not contain value (7) // ERROR, parentheses missing!

Instead, you need to write:

map should (contain key ("two") and not contain value (7))

Here are some more examples:

number should (be > (0) and be <= (10))
option should (equal (Some(List(1, 2, 3))) or be (None))
string should (
  equal ("fee") or
  equal ("fie") or
  equal ("foe") or
  equal ("fum")
)

Two differences exist between expressions composed of these and and or operators and the expressions you can write on regular Booleans using its && and || operators. First, expressions with and and or do not short-circuit. The following contrived expression, for example, would print "hello, world!":

"yellow" should (equal ("blue") and equal { println("hello, world!"); "green" })

In other words, the entire and or or expression is always evaluated, so you'll see any side effects of the right-hand side even if evaluating only the left-hand side is enough to determine the ultimate result of the larger expression. Failure messages produced by these expressions will "short-circuit," however, mentioning only the left-hand side if that's enough to determine the result of the entire expression. This "short-circuiting" behavior of failure messages is intended to make it easier and quicker for you to ascertain which part of the expression caused the failure. The failure message for the previous expression, for example, would be:

"yellow" did not equal "blue"

Most likely this lack of short-circuiting would rarely be noticeable, because evaluating the right hand side will usually not involve a side effect. One situation where it might show up, however, is if you attempt to and a null check on a variable with an expression that uses the variable, like this:

map should (not be (null) and contain key ("ouch"))

If map is null, the test will indeed fail, but with a NullPointerException, not a TestFailedException. Here, the NullPointerException is the visible right-hand side effect. To get a TestFailedException, you would need to check each assertion separately:

map should not be (null)
map should contain key ("ouch")

If map is null in this case, the null check in the first expression will fail with a TestFailedException, and the second expression will never be executed.

The other difference with Boolean operators is that although && has a higher precedence than ||, and and or have the same precedence. Thus although the Boolean expression (a || b && c) will evaluate the && expression before the || expression, like (a || (b && c)), the following expression:

traversable should (contain (7) or contain (8) and have size (9))

Will evaluate left to right, as:

traversable should ((contain (7) or contain (8)) and have size (9))

If you really want the and part to be evaluated first, you'll need to put in parentheses, like this:

traversable should (contain (7) or (contain (8) and have size (9)))

Working with `Option`s

ScalaTest matchers has no special support for Options, but you can work with them quite easily using syntax shown previously. For example, if you wish to check whether an option is None, you can write any of:

option should equal (None)
option should be (None)
option should not be ('defined)
option should be ('empty)

If you wish to check an option is defined, and holds a specific value, you can write either of:

option should equal (Some("hi"))
option should be (Some("hi"))

If you only wish to check that an option is defined, but don't care what it's value is, you can write:

option should be ('defined)

If you mix in (or import the members of) OptionValues, you can write one statement that indicates you believe an option should be defined and then say something else about its value. Here's an example:

import org.scalatest.OptionValues._
option.value should be < (7)

Checking arbitrary properties with `have`

Using have, you can check properties of any type, where a property is an attribute of any object that can be retrieved either by a public field, method, or JavaBean-style get or is method, like this:

book should have (
  'title ("Programming in Scala"),
  'author (List("Odersky", "Spoon", "Venners")),
  'pubYear (2008)
)

This expression will use reflection to ensure the title, author, and pubYear properties of object book are equal to the specified values. For example, it will ensure that book has either a public Java field or method named title, or a public method named getTitle, that when invoked (or accessed in the field case) results in a the string "Programming in Scala". If all specified properties exist and have their expected values, respectively, execution will continue. If one or more of the properties either does not exist, or exists but results in an unexpected value, a TestFailedException will be thrown that explains the problem. (For the details on how a field or method is selected during this process, see the documentation for HavePropertyMatcherGenerator.)

When you use this syntax, you must place one or more property values in parentheses after have, seperated by commas, where a property value is a symbol indicating the name of the property followed by the expected value in parentheses. The only exceptions to this rule is the syntax for checking size and length shown previously, which does not require parentheses. If you forget and put parentheses in, however, everything will still work as you'd expect. Thus instead of writing:

array should have length (3)
set should have size (90)

You can alternatively, write:

array should have (length (3))
set should have (size (90))

If a property has a value different from the specified expected value, a TestFailedError will be thrown with a detail message that explains the problem. For example, if you assert the following on a book whose title is Moby Dick:

book should have ('title ("A Tale of Two Cities"))

You'll get a TestFailedException with this detail message:

The title property had value "Moby Dick", instead of its expected value "A Tale of Two Cities",
on object Book("Moby Dick", "Melville", 1851)

If you prefer to check properties in a type-safe manner, you can use a HavePropertyMatcher. This would allow you to write expressions such as:

book should have (
  title ("Programming in Scala"),
  author (List("Odersky", "Spoon", "Venners")),
  pubYear (2008)
)

These expressions would fail to compile if should is used on an inappropriate type, as determined by the type parameter of the HavePropertyMatcher being used. (For example, title in this example might be of type HavePropertyMatcher[org.publiclibrary.Book]. If used with an appropriate type, such an expression will compile and at run time the property method or field will be accessed directly; i.e., no reflection will be used. See the documentation for HavePropertyMatcher for more information.

Using custom matchers

If none of the built-in matcher syntax (or options shown so far for extending the syntax) satisfy a particular need you have, you can create custom Matchers that allow you to place your own syntax directly after should. For example, class java.io.File has a method exists, which indicates whether a file of a certain path and name exists. Because the exists method takes no parameters and returns Boolean, you can call it using be with a symbol or BePropertyMatcher, yielding assertions like:

file should be ('exists)  // using a symbol
file should be (inExistance)   // using a BePropertyMatcher

Although these expressions will achieve your goal of throwing a TestFailedException if the file does not exist, they don't produce the most readable code because the English is either incorrect or awkward. In this case, you might want to create a custom Matcher[java.io.File] named exist, which you could then use to write expressions like:

// using a plain-old Matcher
file should exist
file should not (exist)
file should (exist and have ('name ("temp.txt")))

Note that when you use custom Matchers, you will need to put parentheses around the custom matcher in more cases than with the built-in syntax. For example you will often need the parentheses after not, as shown above. (There's no penalty for always surrounding custom matchers with parentheses, and if you ever leave them off when they are needed, you'll get a compiler error.) For more information about how to create custom Matchers, please see the documentation for the Matcher trait.

Checking for expected exceptions

Sometimes you need to test whether a method throws an expected exception under certain circumstances, such as when invalid arguments are passed to the method. With ShouldMatchers mixed in, you can check for an expected exception like this:

evaluating { s.charAt(-1) } should produce [IndexOutOfBoundsException]

If charAt throws an instance of StringIndexOutOfBoundsException, this expression will result in that exception. But if charAt completes normally, or throws a different exception, this expression will complete abruptly with a TestFailedException. This expression returns the caught exception so that you can inspect it further if you wish, for example, to ensure that data contained inside the exception has the expected values. Here's an example:

val thrown = evaluating { s.charAt(-1) } should produce [IndexOutOfBoundsException]
thrown.getMessage should equal ("String index out of range: -1")

Those pesky parens

Perhaps the most tricky part of writing assertions using ScalaTest matchers is remembering when you need or don't need parentheses, but bearing in mind a few simple rules should help. It is also reassuring to know that if you ever leave off a set of parentheses when they are required, your code will not compile. Thus the compiler will help you remember when you need the parens. That said, the rules are:

1. Although you don't always need them, it is recommended style to always put parentheses around right-hand values, such as the 7 in num should equal (7):

result should equal (4)
array should have length (3)
book should have (
  'title ("Programming in Scala"),
  'author (List("Odersky", "Spoon", "Venners")),
  'pubYear (2008)
)
option should be ('defined)
catMap should (contain key (9) and contain value ("lives"))
keyEvent should be an ('actionKey)
javaSet should have size (90)

2. Except for length and size, you must always put parentheses around the list of one or more property values following a have:

file should (exist and have ('name ("temp.txt")))
book should have (
  title ("Programming in Scala"),
  author (List("Odersky", "Spoon", "Venners")),
  pubYear (2008)
)
javaList should have length (9) // parens optional for length and size

3. You must always put parentheses around and and or expressions, as in:

catMap should (contain key (9) and contain value ("lives"))
number should (equal (2) or equal (4) or equal (8))

4. Although you don't always need them, it is recommended style to always put parentheses around custom Matchers when they appear directly after not:

file should exist
file should not (exist)
file should (exist and have ('name ("temp.txt")))
file should (not (exist) and have ('name ("temp.txt"))
file should (have ('name ("temp.txt") or exist)
file should (have ('name ("temp.txt") or not (exist))

That's it. With a bit of practice it should become natural to you, and the compiler will always be there to tell you if you forget a set of needed parentheses.

Linear Supertypes

ShouldVerb, Matchers, ClassicMatchers, Assertions, AnyRef, Any

Known Subclasses

ShouldMatchers, ShouldMatchersForJUnit, ShouldMatchersForJUnit

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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

trait ShouldMatchers extends Matchers with ShouldVerb

Checking size and length

Checking strings

Greater and less than

Checking equality with be ===

Checking Boolean properties with be

Using custom BeMatchers

Checking object identity

Checking numbers against a range

Traversables, iterables, sets, sequences, and maps

Java collections and maps

Be as an equality comparison

Being negative

Logical expressions with and and or

Working with Options

Checking arbitrary properties with have

Using custom matchers

Checking for expected exceptions

Those pesky parens

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]