org.scalatest.matchers

MustMatchers

trait MustMatchers extends Assertions with Tolerance with MustVerb with LoneElement with MatcherWords with Explicitly

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

result must 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 must 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) must 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 must have length (3)

Size is similar:

result must 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 must startWith ("Hello")
string must endWith ("world")
string must include ("seven")

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

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

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

string must 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 must be < (7)
one must be > (0)
one must be <= (7)
one must 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 must 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 must 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) must 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 must 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 must 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 must 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 must be (empty)
temp must be a (file)
keyEvent must be an (actionKey)

These expressions would fail to compile if must 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 must be (odd)
num must 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 must 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 must equal:

sevenDotOh must 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 must 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 must 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 must be ('empty)

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

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

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

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

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

iterable must contain ("five")

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

map must contain key (1)
map must 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 must be ('empty)
javaMap must 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 must have length (9)

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

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

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

javaCollection must 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 must contain key (1)
javaMap must 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 must equal (null)

You can write:

result must 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 must be (7.0)
boring must be (false)
fun must be (true)
list must be (Nil)
option must be (None)
option must 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) must 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 must 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 must not be (null)
sum must not be <= (10)
mylist must not equal (yourList)
string must 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 must contain key ("two") and not contain value (7) // ERROR, parentheses missing!

Instead, you need to write:

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

Here are some more examples:

number must (be > (0) and be <= (10))
option must (equal (Some(List(1, 2, 3))) or be (None))
string must (
  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" must (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 must (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 must not be (null)
map must 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 must (contain (7) or contain (8) and have size (9))

Will evaluate left to right, as:

traversable must ((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 must (contain (7) or (contain (8) and have size (9)))

Working with Options

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 must equal (None)
option must be (None)
option must not be ('defined)
option must be ('empty)

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

option must equal (Some("hi"))
option must 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 must be ('defined)

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

import org.scalatest.OptionValues._
option.value must 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 must 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 must have length (3)
set must have size (90)

You can alternatively, write:

array must have (length (3))
set must 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 must 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 must have (
  title ("Programming in Scala"),
  author (List("Odersky", "Spoon", "Venners")),
  pubYear (2008)
)

These expressions would fail to compile if must 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 must. 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 must be ('exists)  // using a symbol
file must 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 must exist
file must not (exist)
file must (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 Matchers mixed in, you can check for an expected exception like this:

evaluating { s.charAt(-1) } must 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) } must produce [IndexOutOfBoundsException]
thrown.getMessage must 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 must equal (7):

result must equal (4)
array must have length (3)
book must have (
  'title ("Programming in Scala"),
  'author (List("Odersky", "Spoon", "Venners")),
  'pubYear (2008)
)
option must be ('defined)
catMap must (contain key (9) and contain value ("lives"))
keyEvent must be an ('actionKey)
javaSet must 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 must (exist and have ('name ("temp.txt")))
book must have (
  title ("Programming in Scala"),
  author (List("Odersky", "Spoon", "Venners")),
  pubYear (2008)
)
javaList must have length (9) // parens optional for length and size

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

catMap must (contain key (9) and contain value ("lives"))
number must (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 must exist
file must not (exist)
file must (exist and have ('name ("temp.txt")))
file must (not (exist) and have ('name ("temp.txt"))
file must (have ('name ("temp.txt") or exist)
file must (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.

Self Type
MustMatchers
Annotations
@deprecated
Deprecated

Please use org.scalatest.Matchers instead.

Linear Supertypes
Explicitly, MatcherWords, LoneElement, MustVerb, Tolerance, Assertions, LegacyTripleEquals, EqualityConstraints, AnyRef, Any
Known Subclasses
MustMatchers, MustMatchersForJUnit, MustMatchersForJUnit
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MustMatchers
  2. Explicitly
  3. MatcherWords
  4. LoneElement
  5. MustVerb
  6. Tolerance
  7. Assertions
  8. LegacyTripleEquals
  9. EqualityConstraints
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. final class AWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  2. final class AnWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  3. class AnyMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  4. final class ArrayMustWrapper[E] extends AnyMustWrapper[Array[E]]

    This class is part of the ScalaTest matchers DSL.

  5. trait ContainMethods[T] extends AnyRef

  6. class DecidedWord extends AnyRef

    Definition Classes
    Explicitly

  7. final class HavePropertyMatcherGenerator extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  8. final class JavaCollectionMustWrapper[E, L[_] <: Collection[_]] extends AnyMustWrapper[L[E]]

    This class is part of the ScalaTest matchers DSL.

  9. final class JavaMapMustWrapper[K, V, L[_, _] <: Map[_, _]] extends AnyMustWrapper[L[K, V]]

    This class is part of the ScalaTest matchers DSL.

  10. final class KeyWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  11. final class LoneElementTraversableWrapper[T] extends AnyRef

    Definition Classes
    LoneElement

  12. final class MapMustWrapper[K, V, L[_, _] <: GenMap[_, _]] extends AnyMustWrapper[L[K, V]]

    This class is part of the ScalaTest matchers DSL.

  13. final class PlusOrMinusWrapper[T] extends AnyRef

    Wrapper class with a +- method that, given a Numeric argument, returns an Interval.

  14. final class RegexWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  15. final class RegexWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  16. class ResultOfBeWordForAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  17. sealed class ResultOfBeWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  18. final class ResultOfBeWordForCollectedArray[T] extends ResultOfBeWordForCollectedAny[Array[T]]

    This class is part of the ScalaTest matchers DSL.

  19. sealed class ResultOfCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  20. final class ResultOfCollectedArray[T] extends ResultOfCollectedAny[Array[T]]

    This class is part of the ScalaTest matchers DSL.

  21. final class ResultOfCollectedGenMap[K, V] extends ResultOfCollectedAny[GenMap[K, V]]

    This class is part of the ScalaTest matchers DSL.

  22. final class ResultOfCollectedGenTraversable[E, C[_] <: GenTraversable[_]] extends ResultOfCollectedAny[C[E]]

    This class is part of the ScalaTest matchers DSL.

  23. final class ResultOfCollectedString extends ResultOfCollectedAny[String]

    This class is part of the ScalaTest matchers DSL.

  24. final class ResultOfContainWordForCollectedArray[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  25. final class ResultOfContainWordForCollectedGenMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  26. final class ResultOfContainWordForCollectedGenTraversable[E, C[_] <: GenTraversable[_]] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  27. final class ResultOfContainWordForJavaCollection[E, L[_] <: Collection[_]] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  28. final class ResultOfContainWordForJavaMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  29. final class ResultOfContainWordForMap[K, V] extends ContainMethods[(K, V)]

    This class is part of the ScalaTest matchers DSL.

  30. class ResultOfContainWordForTraversable[E] extends ContainMethods[E]

    This class is part of the ScalaTest matchers DSL.

  31. final class ResultOfElementWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  32. final class ResultOfEndWithWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  33. final class ResultOfEndWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  34. final class ResultOfEvaluatingApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  35. final class ResultOfFullyMatchWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  36. final class ResultOfFullyMatchWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  37. final class ResultOfHaveWordForCollectedExtent[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  38. final class ResultOfHaveWordForExtent[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  39. final class ResultOfIncludeWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  40. final class ResultOfIncludeWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  41. sealed class ResultOfNewContainWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  42. sealed class ResultOfNotWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  43. sealed class ResultOfNotWordForCollectedArray[E, T <: Array[E]] extends ResultOfNotWordForCollectedAny[T]

    This class is part of the ScalaTest matchers DSL.

  44. final class ResultOfNotWordForCollectedGenMap[K, V, T <: GenMap[K, V]] extends ResultOfNotWordForCollectedAny[T]

    This class is part of the ScalaTest matchers DSL.

  45. sealed class ResultOfNotWordForCollectedGenTraversable[E, C[_] <: GenTraversable[_]] extends ResultOfNotWordForCollectedAny[C[E]]

    This class is part of the ScalaTest matchers DSL.

  46. final class ResultOfNotWordForCollectedString extends ResultOfNotWordForCollectedAny[String]

    This class is part of the ScalaTest matchers DSL.

  47. final class ResultOfProduceInvocation[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  48. final class ResultOfStartWithWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  49. final class ResultOfStartWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  50. final class StringMustWrapper extends AnyMustWrapper[String] with StringMustWrapperForVerb

    This class is part of the ScalaTest matchers DSL.

  51. trait StringMustWrapperForVerb extends AnyRef

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

  52. class TheAfterWord extends AnyRef

    Definition Classes
    Explicitly

  53. final class TheSameInstanceAsPhrase extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  54. class TraversableMustWrapper[E, L[_] <: GenTraversable[_]] extends AnyMustWrapper[L[E]]

    This class is part of the ScalaTest matchers DSL.

  55. final class ValueWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. def !==[T](right: Interval[T]): TripleEqualsInvocationOnInterval[T]

    Returns a TripleEqualsInvocationOnInterval[T], given an Interval[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

    Returns a TripleEqualsInvocationOnInterval[T], given an Interval[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

    right

    the Interval[T] against which to compare the left-hand value

    returns

    a TripleEqualsInvocationOnInterval wrapping the passed Interval[T] value, with expectingEqual set to false.

    Definition Classes
    EqualityConstraints

  4. def !==(right: Null): TripleEqualsInvocation[Null]

    Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

    Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

    right

    a null reference

    returns

    a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to false.

    Definition Classes
    EqualityConstraints

  5. def !==[T](right: T): TripleEqualsInvocation[T]

    Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

    Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

    right

    the right-hand side value for an equality assertion

    returns

    a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to false.

    Definition Classes
    EqualityConstraints

  6. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    This method enables the following syntax:

    This method enables the following syntax:

    num must (not be < (10) and not be > (17))
                   ^

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

    This method enables the following syntax:

    This method enables the following syntax:

    num must (not be <= (10) and not be > (17))
                   ^

  9. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  11. def ===[T](right: Interval[T]): TripleEqualsInvocationOnInterval[T]

    Returns a TripleEqualsInvocationOnInterval[T], given an Interval[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

    Returns a TripleEqualsInvocationOnInterval[T], given an Interval[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

    right

    the Interval[T] against which to compare the left-hand value

    returns

    a TripleEqualsInvocationOnInterval wrapping the passed Interval[T] value, with expectingEqual set to true.

    Definition Classes
    EqualityConstraints

  12. def ===(right: Null): TripleEqualsInvocation[Null]

    Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

    Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

    right

    a null reference

    returns

    a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to true.

    Definition Classes
    EqualityConstraints

  13. def ===[T](right: T): TripleEqualsInvocation[T]

    Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

    Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

    right

    the right-hand side value for an equality assertion

    returns

    a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to true.

    Definition Classes
    EqualityConstraints

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

    This method enables the following syntax:

    This method enables the following syntax:

    num must (not be > (10) and not be < (7))
                   ^

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

    This method enables the following syntax:

    This method enables the following syntax:

    num must (not be >= (10) and not be < (7))
                   ^

  16. val a: AWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook must not be a ('goodRead)
                      ^

  17. val after: TheAfterWord

    Definition Classes
    Explicitly

  18. def all[K, V](xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  19. def all[T](xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  20. def all[E, C[_] <: GenTraversable[_]](xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  21. def all(xs: GenTraversable[String]): ResultOfCollectedString

  22. def all[T](xs: GenTraversable[T]): ResultOfCollectedAny[T]

  23. def allOf[T](xs: T*)(implicit equality: Equality[T]): AllOfContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (allOf(1, 2))
                              ^

  24. val an: AnWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook must not be an (excellentRead)
                      ^

  25. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Assert that an Option[String] is None.

    Assert that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestFailedException with the String value of the Some included in the TestFailedException's detail message.

    This form of assert is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:

    assert(a === b)

    For more information on how this mechanism works, see the documentation for Equalizer.

    o

    the Option[String] to assert

    Definition Classes
    Assertions
    Exceptions thrown
    TestFailedException

    if the Option[String] is Some.

  27. 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
    Exceptions thrown
    NullPointerException

    if message is null.

    TestFailedException

    if the Option[String] is Some.

  28. 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
    Exceptions thrown
    NullPointerException

    if message is null.

    TestFailedException

    if the condition is false.

  29. def assert(condition: Boolean): Unit

    Assert that a boolean condition is true.

    Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

    condition

    the boolean condition to assert

    Definition Classes
    Assertions
    Exceptions thrown
    TestFailedException

    if the condition is false.

  30. def assertResult(expected: Any)(actual: Any): Unit

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

    Assert that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), assertResult returns normally. Else, assertResult throws a TestFailedException whose detail message includes the expected and actual values.

    expected

    the expected value

    actual

    the actual value, which should equal the passed expected value

    Definition Classes
    Assertions
    Exceptions thrown
    TestFailedException

    if the passed actual value does not equal the passed expected value.

  31. def assertResult(expected: Any, clue: Any)(actual: Any): Unit

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

    Assert that the value passed as expected equals the value passed as actual. If the actual equals the expected (as determined by ==), assertResult returns normally. Else, if actual is not equal to expected, assertResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.

    expected

    the expected value

    clue

    An object whose toString method returns a message to include in a failure report.

    actual

    the actual value, which should equal the passed expected value

    Definition Classes
    Assertions
    Exceptions thrown
    TestFailedException

    if the passed actual value does not equal the passed expected value.

  32. 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
    Exceptions thrown
    TestFailedException

    if the Option[String] is Some.

  33. 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
    Exceptions thrown
    NullPointerException

    if message is null.

    TestCanceledException

    if the Option[String] is Some.

  34. 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
    Exceptions thrown
    NullPointerException

    if message is null.

    TestFailedException

    if the condition is false.

  35. 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
    Exceptions thrown
    TestCanceledException

    if the condition is false.

  36. def atLeast[K, V](num: Int, xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  37. def atLeast[T](num: Int, xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  38. def atLeast[E, C[_] <: GenTraversable[_]](num: Int, xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  39. def atLeast(num: Int, xs: GenTraversable[String]): ResultOfCollectedString

  40. def atLeast[T](num: Int, xs: GenTraversable[T]): ResultOfCollectedAny[T]

  41. def atLeastOneOf(xs: Any*): ResultOfAtLeastOneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (atLeastOneOf(1, 2))
                              ^

  42. def atMost[K, V](num: Int, xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  43. def atMost[T](num: Int, xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  44. def atMost[E, C[_] <: GenTraversable[_]](num: Int, xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  45. def atMost(num: Int, xs: GenTraversable[String]): ResultOfCollectedString

  46. def atMost[T](num: Int, xs: GenTraversable[T]): ResultOfCollectedAny[T]

  47. 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
    MatcherWords

  48. def between[K, V](from: Int, upTo: Int, xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  49. def between[T](from: Int, upTo: Int, xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  50. def between[E, C[_] <: GenTraversable[_]](from: Int, upTo: Int, xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  51. def between(from: Int, upTo: Int, xs: GenTraversable[String]): ResultOfCollectedString

  52. def between[T](from: Int, upTo: Int, xs: GenTraversable[T]): ResultOfCollectedAny[T]

  53. 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
    Exceptions thrown
    NullPointerException

    if cause is null

  54. 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
    Exceptions thrown
    NullPointerException

    if message or cause is null

  55. 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
    Exceptions thrown
    NullPointerException

    if message is null

  56. def cancel(): Nothing

    Throws TestCanceledException to indicate a test was canceled.

    Throws TestCanceledException to indicate a test was canceled.

    Definition Classes
    Assertions

  57. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  58. 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
    MatcherWords

  59. def conversionCheckedEqualityConstraint[A, B](implicit equalityOfA: Equality[A], cnv: (B) ⇒ A): EqualityConstraint[A, B]

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an implicit Equality[A].

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an implicit Equality[A].

    The implicitly passed Equality[A] must be used to determine equality by the returned EqualityConstraint's areEqual method.

    This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals) and ConversionCheckedLegacyTripleEquals, and overriden as non-implicit by the other subtraits in this package.

    equalityOfA

    an Equality[A] type class to which the EqualityConstraint.areEqual method will delegate to determine equality.

    cnv

    an implicit conversion from B to A

    returns

    an EqualityConstraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  60. 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 must (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]].

  61. implicit def convertNumericToPlusOrMinusWrapper[T](pivot: T)(implicit arg0: Numeric[T]): PlusOrMinusWrapper[T]

    Implicitly converts an object of a Numeric type to a PlusOrMinusWrapper, to enable a +- method to be invoked on that object.

    Implicitly converts an object of a Numeric type to a PlusOrMinusWrapper, to enable a +- method to be invoked on that object.

    Definition Classes
    Tolerance

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

  63. implicit def convertToAnyMustWrapper[T](o: T): AnyMustWrapper[T]

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

  64. implicit def convertToArrayMustWrapper[T](o: Array[T]): ArrayMustWrapper[T]

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

  65. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Convert to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

    Convert to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

    This method is overridden and made implicit by subtraits TypeCheckedTripleEquals and ConversionCheckedTripleEquals, and overriden as non-implicit by the other subtraits in this package.

    left

    the object whose type to convert to CheckingEqualizer.

    Definition Classes
    LegacyTripleEquals → EqualityConstraints
    Exceptions thrown
    NullPointerException

    if left is null.

  66. def convertToEqualizer[T](left: T): Equalizer[T]

    Convert to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

    Convert to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

    This method is overridden and made implicit by subtrait TripleEquals and overriden as non-implicit by the other subtraits in this package.

    left

    the object whose type to convert to Equalizer.

    Definition Classes
    LegacyTripleEquals → EqualityConstraints
    Exceptions thrown
    NullPointerException

    if left is null.

  67. implicit def convertToJavaCollectionMustWrapper[E, L[_] <: Collection[_]](o: L[E]): JavaCollectionMustWrapper[E, L]

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

  68. implicit def convertToJavaMapMustWrapper[K, V, L[_, _] <: Map[_, _]](o: L[K, V]): JavaMapMustWrapper[K, V, L]

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

  69. def convertToLegacyCheckingEqualizer[T](left: T): LegacyCheckingEqualizer[T]

    Convert to a LegacyCheckingEqualizer that provides === and !== operators that result in Option[String] and enforce a type constraint.

    Convert to a LegacyCheckingEqualizer that provides === and !== operators that result in Option[String] and enforce a type constraint.

    This method is overridden and made implicit by subtraits TypeCheckedLegacyTripleEquals and ConversionCheckedLegacyTripleEquals, and overriden as non-implicit by the other subtraits in this package.

    left

    the object whose type to convert to LegacyCheckingEqualizer.

    Definition Classes
    LegacyTripleEquals → EqualityConstraints
    Exceptions thrown
    NullPointerException

    if left is null.

  70. implicit def convertToLegacyEqualizer[T](left: T): LegacyEqualizer[T]

    Convert to a LegacyEqualizer that provides === and !== operators that result in Option[String] and enforce no type constraint.

    Convert to a LegacyEqualizer that provides === and !== operators that result in Option[String] and enforce no type constraint.

    This method is overridden and made implicit by subtrait LegacyTripleEquals and overriden as non-implicit by the other subtraits in this package.

    left

    the object whose type to convert to LegacyEqualizer.

    Definition Classes
    LegacyTripleEquals → EqualityConstraints
    Exceptions thrown
    NullPointerException

    if left is null.

  71. implicit def convertToMapMustWrapper[K, V, L[_, _] <: GenMap[_, _]](o: L[K, V]): MapMustWrapper[K, V, L]

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

  72. implicit def convertToRegexWrapper(o: Regex): RegexWrapper

    Implicitly converts an object of type scala.util.matching.Regex to a RegexWrapper, to enable withGroup and withGroups methods to be invokable on that object.

  73. implicit def convertToStringMustWrapper(o: String): StringMustWrapper

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

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

    Definition Classes
    MustMatchers → MustVerb

  74. def convertToTraversableLoneElementWrapper[T](xs: GenTraversable[T]): LoneElementTraversableWrapper[T]

    Turn off implicit conversion of LoneElement, so that if user accidentally mixin LoneElement it does conflict with convertToTraversableMustWrapper

    Turn off implicit conversion of LoneElement, so that if user accidentally mixin LoneElement it does conflict with convertToTraversableMustWrapper

    Definition Classes
    MustMatchers → LoneElement

  75. implicit def convertToTraversableMustWrapper[E, L[_] <: GenTraversable[_]](o: L[E]): TraversableMustWrapper[E, L]

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

  76. 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) must (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]].

  77. 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 must 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]].

  78. val decided: DecidedWord

    Definition Classes
    Explicitly

  79. implicit def defaultEquality[A]: Equality[A]

    Return an Equality[A] for any type A that determines equality via the == operator on type A.

    Return an Equality[A] for any type A that determines equality via the == operator on type A.

    returns

    a DefaultEquality for type A

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  80. def definedAt[T](right: T): ResultOfDefinedAt[T]

    This method enables the following syntax:

    This method enables the following syntax:

    list must (not be definedAt (7) and not be definedAt (9))
                    ^

  81. def doCollected[T](collected: Collected, xs: GenTraversable[T], methodName: String, stackDepth: Int)(fun: (T) ⇒ Unit): Unit

  82. 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
    MatcherWords

  83. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  84. def equal(o: Null): Matcher[AnyRef]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must equal (null)
       ^

  85. def equal[T](interval: Interval[T]): Matcher[T]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must equal (100 +- 1)
              ^

  86. def equal(right: Any): MatcherFactory1[Any, Equality]

    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
    MatcherWords

  87. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  88. 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) } must produce [StringIndexOutOfBoundsException]
^

  89. def every[K, V](xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  90. def every[T](xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  91. def every[E, C[_] <: GenTraversable[_]](xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  92. def every(xs: GenTraversable[String]): ResultOfCollectedString

  93. def every[T](xs: GenTraversable[T]): ResultOfCollectedAny[T]

  94. def exactly[K, V](num: Int, xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  95. def exactly[T](num: Int, xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  96. def exactly[E, C[_] <: GenTraversable[_]](num: Int, xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  97. def exactly(num: Int, xs: GenTraversable[String]): ResultOfCollectedString

  98. def exactly[T](num: Int, xs: GenTraversable[T]): ResultOfCollectedAny[T]

  99. def fail(cause: Throwable): Nothing

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

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

    cause

    a Throwable that indicates the cause of the failure.

    Definition Classes
    Assertions
    Exceptions thrown
    NullPointerException

    if cause is null

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

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

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

    message

    A message describing the failure.

    cause

    A Throwable that indicates the cause of the failure.

    Definition Classes
    Assertions
    Exceptions thrown
    NullPointerException

    if message or cause is null

  101. def fail(message: String): Nothing

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

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

    message

    A message describing the failure.

    Definition Classes
    Assertions
    Exceptions thrown
    NullPointerException

    if message is null

  102. def fail(): Nothing

    Throws TestFailedException to indicate a test failed.

    Throws TestFailedException to indicate a test failed.

    Definition Classes
    Assertions

  103. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  104. 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
    MatcherWords

  105. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  106. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  107. 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
    MatcherWords

  108. def inOrder[T](xs: T*)(implicit equality: Equality[T]): InOrderContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (inOrder(1, 2))
                              ^

  109. def inOrderOnly[T](xs: T*)(implicit equality: Equality[T]): InOrderOnlyContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (inOrderOnly(1, 2))
                              ^

  110. 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
    MatcherWords

  111. def intercept[T <: AnyRef](f: ⇒ Any)(implicit manifest: Manifest[T]): T

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

    Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

    Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

    f

    the function value that should throw the expected exception

    manifest

    an implicit Manifest representing the type of the specified type parameter.

    returns

    the intercepted exception, if it is of the expected type

    Definition Classes
    Assertions
    Exceptions thrown
    TestFailedException

    if the passed function does not complete abruptly with an exception that's an instance of the specified type passed expected value.

  112. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  113. val key: KeyWord

    This field enables the following syntax:

    This field enables the following syntax:

    map must not contain key (10)
                       ^

  114. def legacyEqual(right: Any): Matcher[Any]

    Definition Classes
    MatcherWords

  115. val length: LengthWord

    This field enables the following syntax:

    This field enables the following syntax:

    "hi" should not have length (3)
                     ^

    Definition Classes
    MatcherWords

  116. def lowPriorityConversionCheckedEqualityConstraint[A, B](implicit equalityOfB: Equality[B], cnv: (A) ⇒ B): EqualityConstraint[A, B]

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an implicit Equality[A].

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an implicit Equality[A].

    The implicitly passed Equality[A] must be used to determine equality by the returned EqualityConstraint's areEqual method.

    This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint (extended by ConversionCheckedTripleEquals), and LowPriorityConversionCheckedLegacyConstraint (extended by ConversionCheckedLegacyTripleEquals), and overriden as non-implicit by the other subtraits in this package.

    cnv

    an implicit conversion from A to B

    returns

    an EqualityConstraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  117. def lowPriorityTypeCheckedEqualityConstraint[A, B](implicit equalityOfA: Equality[A], ev: <:<[A, B]): EqualityConstraint[A, B]

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equality[A].

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equality[A].

    The implicitly passed Equality[A] must be used to determine equality by the returned EqualityConstraint's areEqual method.

    This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and LowPriorityTypeCheckedLegacyConstraint (extended by TypeCheckedLegacyTripleEquals), and overriden as non-implicit by the other subtraits in this package.

    equalityOfA

    an Equality[A] type class to which the EqualityConstraint.areEqual method will delegate to determine equality.

    ev

    evidence that A is a subype of B

    returns

    an EqualityConstraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  118. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  119. val newContain: NewContainWord

    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
    MatcherWords

  120. def newOneOf(xs: Any*): ResultOfNewOneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (oneOf(1, 2))
                              ^

  121. def no[K, V](xs: GenTraversable[GenMap[K, V]]): ResultOfCollectedGenMap[K, V]

  122. def no[T](xs: GenTraversable[Array[T]]): ResultOfCollectedArray[T]

  123. def no[E, C[_] <: GenTraversable[_]](xs: GenTraversable[C[E]]): ResultOfCollectedGenTraversable[E, C]

  124. def no(xs: GenTraversable[String]): ResultOfCollectedString

  125. def no[T](xs: GenTraversable[T]): ResultOfCollectedAny[T]

  126. def noneOf[T](xs: T*)(implicit equality: Equality[T]): NoneOfContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (noneOf(1, 2))
                              ^

  127. 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
    MatcherWords

  128. final def notify(): Unit

    Definition Classes
    AnyRef

  129. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  130. def oneOf[T](xs: T*)(implicit equality: Equality[T]): OneOfContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (oneOf(1, 2))
                              ^

  131. def only[T](xs: T*)(implicit equality: Equality[T]): OnlyContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) must contain (only(1, 2))
                              ^

  132. 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) } must produce [StringIndexOutOfBoundsException]
^

  133. val regex: RegexWord

    This field enables the following syntax:

    This field enables the following syntax:

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

  134. val size: SizeWord

    This field enables the following syntax:

    This field enables the following syntax:

    set should not have size (3)
                    ^

    Definition Classes
    MatcherWords

  135. 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
    MatcherWords

  136. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  137. def theSameElementsAs[T](xs: Array[T])(implicit equality: Equality[T]): TheSameElementsAsContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    traversable must contain (theSameElementsAs(array))
                            ^

  138. def theSameElementsAs[T](xs: GenTraversable[T])(implicit equality: Equality[T]): TheSameElementsAsContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    traversable must contain (theSameElementsAs(anotherTraversable))
                            ^

  139. def theSameElementsInOrderAs[T](xs: Array[T])(implicit equality: Equality[T]): TheSameElementsInOrderAsContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    traversable must contain (theSameElementsInOrderAs(array))
                            ^

  140. def theSameElementsInOrderAs[T](xs: GenTraversable[T])(implicit equality: Equality[T]): TheSameElementsInOrderAsContainMatcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    traversable must contain (theSameElementsInOrderAs(anotherTraversable))
                            ^

  141. val theSameInstanceAs: TheSameInstanceAsPhrase

    This field enables the following syntax:

    This field enables the following syntax:

    oneString must not be theSameInstanceAs (anotherString)
                        ^

  142. def toString(): String

    Definition Classes
    AnyRef → Any

  143. def typeCheckedEqualityConstraint[A, B](implicit equalityOfA: Equality[A], ev: <:<[B, A]): EqualityConstraint[A, B]

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equality[A].

    Provides an EqualityConstraint[A, B] class for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equality[A].

    The implicitly passed Equality[A] must be used to determine equality by the returned EqualityConstraint's areEqual method.

    This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and TypeCheckedLegacyTripleEquals, and overriden as non-implicit by the other subtraits in this package.

    equalityOfA

    an Equality[A] type class to which the EqualityConstraint.areEqual method will delegate to determine equality.

    ev

    evidence that B is a subype of A

    returns

    an EqualityConstraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  144. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): EqualityConstraint[A, B]

    Provides an EqualityConstraint[A, B] class for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

    Provides an EqualityConstraint[A, B] class for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

    The implicitly passed Equality[A] must be used to determine equality by the returned EqualityConstraint's areEqual method.

    This method is overridden and made implicit by subtraits TripleEquals and LegacyTripleEquals, and overriden as non-implicit by the other subtraits in this package.

    equalityOfA

    an Equality[A] type class to which the EqualityConstraint.areEqual method will delegate to determine equality.

    returns

    an EqualityConstraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    LegacyTripleEquals → EqualityConstraints

  145. val value: ValueWord

    This field enables the following syntax:

    This field enables the following syntax:

    map must not contain value (10)
                       ^

  146. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  147. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  148. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  149. def withClue[T](clue: Any)(fun: ⇒ T): T

    Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it.

    Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

    This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:

    withClue("(Employee's name was: " + employee.name + ")") {
  intercept[IllegalArgumentException] {
    employee.getTask(-1)
  }
}

    If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:

    (Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown

    Definition Classes
    Assertions
    Exceptions thrown
    NullPointerException

    if the passed clue is null

Deprecated Value Members

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

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

  3. def expectResult(expected: Any)(actual: Any): Unit

    This expectResult method has been deprecated; Please use assertResult instead.

    This expectResult method has been deprecated; Please use assertResult instead.

    To get rid of the deprecation warning, simply replace expectResult with assertResult. The name expectResult will be used for a different purposes in a future version of ScalaTest.

    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.

  4. def expectResult(expected: Any, clue: Any)(actual: Any): Unit

    This expectResult method has been deprecated; Please use assertResult instead.

    This expectResult method has been deprecated; Please use assertResult instead.

    To get rid of the deprecation warning, simply replace expectResult with assertResult. The name expectResult will be used for a different purposes in a future version of ScalaTest.

    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.

Inherited from Explicitly

Inherited from MatcherWords

Inherited from LoneElement

Inherited from MustVerb

Inherited from Tolerance

Inherited from Assertions

Inherited from LegacyTripleEquals

Inherited from EqualityConstraints

Inherited from AnyRef

Inherited from Any

Ungrouped