org.scalatest.matchers

MustMatchers

trait MustMatchers extends Matchers with MustVerb

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

object must equal (3)

Here object 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 left is an array, deepEquals will be invoked on left, passing in right. 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 deepEquals 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:

object must have length (3)

Size is similar:

object must have size (10)

The length syntax can be used with any object that has a field or method named length or a method named getLength. Similarly, the size syntax can be used with any object that has a field or method named size or a method named getSize. The type of a length or size field, or return type of a method, must be either Int or Long. Any such method must take no parameters. (The Scala compiler will ensure at compile time that the object on which must is being invoked has the appropriate structure.)

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:

object must be === (3)

Here object 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 left is an array, deepEquals will be invoked on left, passing in right. 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 deepEquals 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)

Iterables, collections, 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 Collection, 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 arrays results in deepEquals being called, not equals. 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:

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

collection must (contain (7) or contain (8) and have size (9))

Will evaluate left to right, as:

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

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

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

known subclasses: MustMatchers, MustMatchersForJUnit
Go to: companion

Inherits

  1. MustVerb
  2. Matchers
  3. Assertions
  4. AnyRef
  5. Any

Type Members

  1. class AWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  2. 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. class AnyRefMustWrapper[T <: AnyRef] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  5. class ArrayMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  6. class BeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  7. class ByteMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  8. class BytePlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  9. class ByteTolerance(right: Byte, tolerance: Byte) extends Product

    This class is part of the ScalaTest matchers DSL

  10. class CollectionMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  11. class ContainWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  12. class DoubleMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  13. class DoublePlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  14. class DoubleTolerance(right: Double, tolerance: Double) extends Product

    This class is part of the ScalaTest matchers DSL

  15. class EndWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  16. class Equalizer extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with === in assertions in tests

  17. class EvaluatingApplicationMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  18. class FloatMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  19. class FloatPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  20. class FloatTolerance(right: Float, tolerance: Float) extends Product

    This class is part of the ScalaTest matchers DSL

  21. class FullyMatchWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  22. class HavePropertyMatcherGenerator extends AnyRef

    This class is part of the ScalaTest matchers DSL

  23. class HaveWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  24. class IncludeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  25. class IntMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  26. class IntPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  27. class IntTolerance(right: Int, tolerance: Int) extends Product

    This class is part of the ScalaTest matchers DSL

  28. class JavaCollectionMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  29. class JavaListMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  30. class JavaMapMustWrapper[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  31. class KeyWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  32. class LengthMustWrapper[A <: AnyRef] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  33. class LengthWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  34. class LengthWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  35. class ListMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  36. class LongMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  37. class LongPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  38. class LongTolerance(right: Long, tolerance: Long) extends Product

    This class is part of the ScalaTest matchers DSL

  39. class MapMustWrapper[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  40. class MatcherWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  41. class NotWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  42. class RegexWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  43. class ResultOfAWordToBePropertyMatcherApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  44. class ResultOfAWordToSymbolApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  45. class ResultOfAnWordToBePropertyMatcherApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  46. class ResultOfAnWordToSymbolApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  47. class ResultOfBeWordForAnyRef[T <: AnyRef] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  48. class ResultOfContainWordForJavaMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  49. class ResultOfContainWordForMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  50. class ResultOfElementWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  51. class ResultOfEndWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL

  52. class ResultOfEvaluatingApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  53. class ResultOfFullyMatchWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL

  54. class ResultOfGreaterThanComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  55. class ResultOfGreaterThanOrEqualToComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  56. class ResultOfHaveWordForArray[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  57. class ResultOfHaveWordForCollection[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  58. class ResultOfHaveWordForJavaCollection[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  59. class ResultOfHaveWordForJavaList[T] extends ResultOfHaveWordForJavaCollection[T]

    This class is part of the ScalaTest matchers DSL

  60. class ResultOfHaveWordForJavaMap extends AnyRef

    This class is part of the ScalaTest matchers DSL

  61. class ResultOfHaveWordForLengthWrapper[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  62. class ResultOfHaveWordForSeq[T] extends ResultOfHaveWordForCollection[T]

    This class is part of the ScalaTest matchers DSL

  63. class ResultOfHaveWordForSizeWrapper[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  64. class ResultOfHaveWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL

  65. class ResultOfIncludeWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL

  66. class ResultOfKeyWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  67. class ResultOfLengthWordApplication extends HavePropertyMatcher[AnyRef, Long]

    This class is part of the ScalaTest matchers DSL

  68. class ResultOfLessThanComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  69. class ResultOfLessThanOrEqualToComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  70. class ResultOfNotWord[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

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

    This class is part of the ScalaTest matchers DSL

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

    This class is part of the ScalaTest matchers DSL

  73. class ResultOfNotWordForByte extends ResultOfNotWord[Byte]

    This class is part of the ScalaTest matchers DSL

  74. class ResultOfNotWordForCollection[E, T <: Iterable[E]] extends ResultOfNotWordForIterable[E, T]

    This class is part of the ScalaTest matchers DSL

  75. class ResultOfNotWordForDouble extends ResultOfNotWord[Double]

    This class is part of the ScalaTest matchers DSL

  76. class ResultOfNotWordForFloat extends ResultOfNotWord[Float]

    This class is part of the ScalaTest matchers DSL

  77. class ResultOfNotWordForInt extends ResultOfNotWord[Int]

    This class is part of the ScalaTest matchers DSL

  78. class ResultOfNotWordForIterable[E, T <: Iterable[E]] extends ResultOfNotWordForAnyRef[T]

    This class is part of the ScalaTest matchers DSL

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

    This class is part of the ScalaTest matchers DSL

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

    This class is part of the ScalaTest matchers DSL

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

    This class is part of the ScalaTest matchers DSL

  82. class ResultOfNotWordForLengthWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

    This class is part of the ScalaTest matchers DSL

  83. class ResultOfNotWordForLong extends ResultOfNotWord[Long]

    This class is part of the ScalaTest matchers DSL

  84. class ResultOfNotWordForMap[K, V] extends ResultOfNotWordForCollection[(K, V), Map[K, V]]

    This class is part of the ScalaTest matchers DSL

  85. class ResultOfNotWordForSeq[E, T <: Seq[E]] extends ResultOfNotWordForCollection[E, T]

    This class is part of the ScalaTest matchers DSL

  86. class ResultOfNotWordForShort extends ResultOfNotWord[Short]

    This class is part of the ScalaTest matchers DSL

  87. class ResultOfNotWordForSizeWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

    This class is part of the ScalaTest matchers DSL

  88. class ResultOfNotWordForString extends ResultOfNotWordForAnyRef[String]

    This class is part of the ScalaTest matchers DSL

  89. class ResultOfProduceInvocation[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  90. class ResultOfRegexWordApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  91. class ResultOfSizeWordApplication extends HavePropertyMatcher[AnyRef, Long]

    This class is part of the ScalaTest matchers DSL

  92. class ResultOfStartWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL

  93. class ResultOfTheSameInstanceAsApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  94. class ResultOfTripleEqualsApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL

  95. class ResultOfValueWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  96. class SeqMustWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  97. class ShortMustWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  98. class ShortPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  99. class ShortTolerance(right: Short, tolerance: Short) extends Product

    This class is part of the ScalaTest matchers DSL

  100. class SizeMustWrapper[A <: AnyRef] extends AnyRef

    This class is part of the ScalaTest matchers DSL

  101. class SizeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  102. class SizeWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL

  103. class StartWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

  104. class StringMustWrapper extends StringMustWrapperForVerb

    This class is part of the ScalaTest matchers DSL

  105. class StringMustWrapperForVerb extends AnyRef

    This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec

  106. class TheSameInstanceAsPhrase extends AnyRef

    This class is part of the ScalaTest matchers DSL

  107. class ValueWord extends AnyRef

    This class is part of the ScalaTest matchers DSL

Value Members

  1. def <[T](right: T)(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: Matchers
    Go to: companion
  2. def <=[T](right: T)(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: Matchers
    Go to: companion
  3. def ===(right: Any): ResultOfTripleEqualsApplication

    This method enables the following syntax:

    This method enables the following syntax:

    num should not be === (10)
                      
    

    definition classes: Matchers
    Go to: companion
  4. def >[T](right: T)(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: Matchers
    Go to: companion
  5. def >=[T](right: T)(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: Matchers
    Go to: companion
  6. val a: AWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be a ('goodRead)
                          
    

    definition classes: Matchers
    Go to: companion
  7. val an: AnWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be an (excellentRead)
                          
    

    definition classes: Matchers
    Go to: companion
  8. 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
    Go to: companion
  9. def assert(o: Option[String], clue: Any): Unit

    Assert that an Option[String] is None

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

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

    assert(a === b, "extra info reported if assertion fails")
    

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

    o

    the Option[String] to assert

    clue

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

    definition classes: Assertions
    Go to: companion
  10. def assert(condition: Boolean, clue: Any): Unit

    Assert that a boolean condition, described in String message, is true

    Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with the String obtained by invoking toString on the specified message as the exception's detail message.

    condition

    the boolean condition to assert

    clue

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

    definition classes: Assertions
    Go to: companion
  11. 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
    Go to: companion
  12. 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: Matchers
    Go to: companion
  13. 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: Matchers
    Go to: companion
  14. 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: Matchers
    Go to: companion
  15. 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: Matchers
    Go to: companion
  16. 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: Matchers
    Go to: companion
  17. def convertGetLengthFieldToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  18. def convertGetLengthFieldToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  19. def convertGetLengthMethodToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  20. def convertGetLengthMethodToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  21. def convertGetSizeFieldToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  22. def convertGetSizeFieldToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  23. def convertGetSizeMethodToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  24. def convertGetSizeMethodToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  25. def convertHasIntGetLengthFieldToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getLength val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getLength val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  26. def convertHasIntGetLengthMethodToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getLength method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getLength method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  27. def convertHasIntGetSizeFieldToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getSize val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getSize val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  28. def convertHasIntGetSizeMethodToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getSize method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getSize method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  29. def convertHasIntLengthFieldToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a length val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a length val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  30. def convertHasIntLengthMethodToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a length method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a length method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  31. def convertHasIntSizeFieldToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a size val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a size val of type Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  32. def convertHasIntSizeMethodToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a size method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a size method that results in Int to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  33. def convertHasLongGetLengthFieldToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getLength val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getLength val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  34. def convertHasLongGetLengthMethodToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getLength method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getLength method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  35. def convertHasLongGetSizeFieldToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getSize val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getSize val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  36. def convertHasLongGetSizeMethodToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a getSize method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a getSize method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  37. def convertHasLongLengthFieldToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a length val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a length val of type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  38. def convertHasLongLengthMethodToLengthMustWrapper[T <: AnyRef {...}](o: T): LengthMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a length method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a length method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  39. def convertHasLongSizeFieldToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a size val type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a size val type Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  40. def convertHasLongSizeMethodToSizeMustWrapper[T <: AnyRef {...}](o: T): SizeMustWrapper[T]

    Implicitly converts an AnyRef of type T whose structure includes a size method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object

    Implicitly converts an AnyRef of type T whose structure includes a size method that results in Long to a SizeMustWrapper[T], to enable must methods to be invokable on that object.

    attributes: implicit
    Go to: companion
  41. 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: Matchers
    Go to: companion
  42. def convertIterableMatcherToArraytMatcher[T](iterableMatcher: Matcher[Iterable[T]]): Matcher[Array[T]]

  43. def convertIterableMatcherToJavaCollectionMatcher[T](iterableMatcher: Matcher[Iterable[T]]): Matcher[Collection[T]]

    This implicit conversion method enables the following syntax (javaColl is a java

    This implicit conversion method enables the following syntax (javaColl is a java.util.Collection):

    javaColl should contain ("two")
    

    The (contain element ("two")) expression will result in a Matcher[scala.Iterable[String]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Collection[String]].

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  44. def convertLengthFieldToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  45. def convertLengthFieldToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  46. def convertLengthMethodToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  47. def convertLengthMethodToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  48. 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: Matchers
    Go to: companion
  49. def convertMapMatcherToJavaMapMatcher[K, V](mapMatcher: Matcher[Map[K, V]]): Matcher[Map[K, V]]

    This implicit conversion method enables the following syntax (javaMap is a java

    This implicit conversion method enables the following syntax (javaMap is a java.util.Map):

    javaMap should (contain key ("two"))
    

    The (contain key ("two")) expression will result in a Matcher[scala.collection.Map[String, Any]]. This implicit conversion method will convert that matcher to a Matcher[java.util.Map[String, Any]].

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  50. 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: Matchers
    Go to: companion
  51. def convertSizeFieldToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  52. def convertSizeFieldToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  53. def convertSizeMethodToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  54. def convertSizeMethodToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

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

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

    attributes: implicit
    definition classes: Matchers
    Go to: companion
  55. 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: Matchers
    Go to: companion
  56. 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

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

    attributes: implicit
    Go to: companion
  57. def convertToAnyRefMustWrapper[T <: AnyRef](o: T): AnyRefMustWrapper[T]

    Implicitly converts a scala

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

    attributes: implicit
    Go to: companion
  58. def convertToArrayMustWrapper[T](o: Array[T]): ArrayMustWrapper[T]

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  59. def convertToByteMustWrapper(o: Byte): ByteMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  60. def convertToCollectionMustWrapper[T](o: Iterable[T]): CollectionMustWrapper[T]

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  61. def convertToDoubleMustWrapper(o: Double): DoubleMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  62. 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
    Go to: companion
  63. def convertToEvaluatingApplicationMustWrapper(o: ResultOfEvaluatingApplication): EvaluatingApplicationMustWrapper

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

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

    attributes: implicit
    Go to: companion
  64. def convertToFloatMustWrapper(o: Float): FloatMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  65. def convertToIntMustWrapper(o: Int): IntMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  66. def convertToJavaCollectionMustWrapper[T](o: Collection[T]): JavaCollectionMustWrapper[T]

    Implicitly converts an object of type java

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

    attributes: implicit
    Go to: companion
  67. def convertToJavaListMustWrapper[T](o: List[T]): JavaListMustWrapper[T]

    Implicitly converts an object of type java

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

    attributes: implicit
    Go to: companion
  68. def convertToJavaMapMustWrapper[K, V](o: Map[K, V]): JavaMapMustWrapper[K, V]

    Implicitly converts an object of type java

    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.

    attributes: implicit
    Go to: companion
  69. def convertToListMustWrapper[T](o: List[T]): ListMustWrapper[T]

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  70. def convertToLongMustWrapper(o: Long): LongMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  71. def convertToMapMustWrapper[K, V](o: Map[K, V]): MapMustWrapper[K, V]

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  72. 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: Matchers
    Go to: companion
  73. def convertToSeqMustWrapper[T](o: Seq[T]): SeqMustWrapper[T]

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  74. def convertToShortMustWrapper(o: Short): ShortMustWrapper

    Implicitly converts an object of type scala

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

    attributes: implicit
    Go to: companion
  75. def convertToStringMustWrapper(o: String): StringMustWrapper

    Implicitly converts an object of type java

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

    attributes: implicit
    Go to: companion
  76. 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: Matchers
    Go to: companion
  77. 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 left is an array, deepEquals will be invoked on left, passing in right. 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 deepEquals 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.

    definition classes: Matchers
    Go to: companion
  78. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
    Go to: companion
  79. 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: Matchers
    Go to: companion
  80. def expect(expected: Any)(actual: Any): Unit

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

    Expect that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), expect returns normally. Else, expect throws an 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
    Go to: companion
  81. def expect(expected: Any, clue: Any)(actual: Any): Unit

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

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

    expected

    the expected value

    clue

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

    actual

    the actual value, which should equal the passed expected value

    definition classes: Assertions
    Go to: companion
  82. 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
    Go to: companion
  83. 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
    Go to: companion
  84. 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
    Go to: companion
  85. def fail(): Nothing

    Throws TestFailedException to indicate a test failed

    Throws TestFailedException to indicate a test failed.

    definition classes: Assertions
    Go to: companion
  86. 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: Matchers
    Go to: companion
  87. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
    Go to: companion
  88. 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: Matchers
    Go to: companion
  89. 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: Matchers
    Go to: companion
  90. def intercept[T <: AnyRef](f: ⇒ Any)(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
    Go to: companion
  91. val key: KeyWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain key (10)
                           
    

    definition classes: Matchers
    Go to: companion
  92. val length: LengthWord

    This field enables the following syntax:

    This field enables the following syntax:

    "hi" should not have length (3)
                         
    

    definition classes: Matchers
    Go to: companion
  93. 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: Matchers
    Go to: companion
  94. def produce[T](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: Matchers
    Go to: companion
  95. 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: Matchers
    Go to: companion
  96. val size: SizeWord

    This field enables the following syntax:

    This field enables the following syntax:

    set should not have size (3)
                        
    

    definition classes: Matchers
    Go to: companion
  97. 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: Matchers
    Go to: companion
  98. val theSameInstanceAs: TheSameInstanceAsPhrase

    This field enables the following syntax:

    This field enables the following syntax:

    oneString should not be theSameInstanceAs (anotherString)
                            
    

    definition classes: Matchers
    Go to: companion
  99. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
    Go to: companion
  100. val value: ValueWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain value (10)
                           
    

    definition classes: Matchers
    Go to: companion