org.scalatest.matchers

ShouldMatchers

trait ShouldMatchers extends Matchers

Annotations
@deprecated
Deprecated

Please use org.scalatest.Matchers instead.

Source
ShouldMatchers.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ShouldMatchers
  2. Matchers
  3. Explicitly
  4. MatcherWords
  5. ShouldVerb
  6. Tolerance
  7. Assertions
  8. TripleEquals
  9. TripleEqualsSupport
  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. sealed class AnyShouldWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  4. class AssertionsHelper extends AnyRef

    Helper class used by code generated by the assert macro.

  5. class CheckingEqualizer[L] extends AnyRef

    Class used via an implicit conversion to enable two objects to be compared with === and !== with a Boolean result and an enforced type constraint between two object types.

  6. class DecidedByEquality[A] extends Equality[A]

    This class is part of the Scalactic “explicitly DSL”.

  7. class DecidedWord extends AnyRef

    This class is part of the Scalactic “explicitly DSL”.

  8. class DeterminedByEquivalence[T] extends Equivalence[T]

    This class is part of the Scalactic “explicitly DSL”.

  9. class DeterminedWord extends AnyRef

    This class is part of the Scalactic “explicitly DSL”.

  10. class Equalizer[L] extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with === and !== with a Boolean result and no enforced type constraint between two object types.

  11. final class HavePropertyMatcherGenerator extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  12. final class KeyWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  13. class LegacyCheckingEqualizer[L] extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with === and !== with an Option[String] result and an enforced type constraint between two object types.

  14. class LegacyEqualizer[L] extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with === and !== with an Option[String] result and no enforced type constraint between two object types.

  15. final class PlusOrMinusWrapper[T] extends AnyRef

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

  16. final class RegexWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  17. final class RegexWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  18. class ResultOfBeWordForAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  19. sealed class ResultOfBeWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

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

    This class is part of the ScalaTest matchers DSL.

  21. final class ResultOfCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  22. final class ResultOfContainWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  23. final class ResultOfEndWithWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  24. final class ResultOfEndWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  25. final class ResultOfEvaluatingApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  26. final class ResultOfFullyMatchWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  27. final class ResultOfFullyMatchWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  28. final class ResultOfHaveWordForCollectedExtent[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  29. final class ResultOfHaveWordForExtent[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  30. final class ResultOfIncludeWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  31. final class ResultOfIncludeWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  32. sealed class ResultOfNotWordForCollectedAny[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  33. final class ResultOfProduceInvocation[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  34. final class ResultOfStartWithWordForCollectedString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  35. final class ResultOfStartWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  36. final class StringShouldWrapper extends AnyShouldWrapper[String] with StringShouldWrapperForVerb

    This class is part of the ScalaTest matchers DSL.

  37. trait StringShouldWrapperForVerb extends AnyRef

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

  38. class TheAfterWord extends AnyRef

    This class is part of the Scalactic “explicitly DSL”.

  39. final class TheSameInstanceAsPhrase extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  40. 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: Spread[T]): TripleEqualsInvocationOnSpread[T]

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

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

    right

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

    returns

    a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to false.

    Definition Classes
    TripleEqualsSupport
  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
    TripleEqualsSupport
  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
    TripleEqualsSupport
  6. final def ##(): Int

    Definition Classes
    AnyRef → Any
  7. def <[T](right: T)(implicit arg0: Ordering[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
  8. def <=[T](right: T)(implicit arg0: Ordering[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
  9. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  11. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

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

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

    right

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

    returns

    a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to true.

    Definition Classes
    TripleEqualsSupport
  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
    TripleEqualsSupport
  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
    TripleEqualsSupport
  14. def >[T](right: T)(implicit arg0: Ordering[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
  15. def >=[T](right: T)(implicit arg0: Ordering[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
  16. def a[T](implicit arg0: Manifest[T]): ResultOfATypeInvocation[T]

    This method enables the following syntax:

    This method enables the following syntax:

    a [RuntimeException] should be thrownBy { ... }
    ^
    

    Definition Classes
    Matchers
  17. val a: AWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be a ('goodRead)
                          ^
    

    Definition Classes
    Matchers
  18. val after: TheAfterWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    result should equal ("hello") (after being lowerCased)
                                   ^
    

    Definition Classes
    Explicitly
  19. def all(xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    all(str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  20. def all[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    all(jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  21. def all[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    all(xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  22. def allOf(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfAllOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  23. def an[T](implicit arg0: Manifest[T]): ResultOfAnTypeInvocation[T]

    This method enables the following syntax:

    This method enables the following syntax:

    an [Exception] should be thrownBy { ... }
    ^
    

    Definition Classes
    Matchers
  24. val an: AnWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be an (excellentRead)
                          ^
    

    Definition Classes
    Matchers
  25. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  26. 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 a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

    This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

    • assert(a == b, "a good clue")
    • assert(a != b, "a good clue")
    • assert(a === b, "a good clue")
    • assert(a !== b, "a good clue")
    • assert(a > b, "a good clue")
    • assert(a >= b, "a good clue")
    • assert(a < b, "a good clue")
    • assert(a <= b, "a good clue")
    • assert(a startsWith "prefix", "a good clue")
    • assert(a endsWith "postfix", "a good clue")
    • assert(a contains "something", "a good clue")
    • assert(a eq b, "a good clue")
    • assert(a ne b, "a good clue")
    • assert(a > 0 && b > 5, "a good clue")
    • assert(a > 0 || b > 5, "a good clue")
    • assert(a.isEmpty, "a good clue")
    • assert(!a.isEmpty, "a good clue")
    • assert(a.isInstanceOf[String], "a good clue")
    • assert(a.length == 8, "a good clue")
    • assert(a.size == 8, "a good clue")
    • assert(a.exists(_ == 8), "a good clue")

    At this time, any other form of expression will just get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean, not Option[String] to be the default in tests. This makes === consistent between tests and production code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String], use can get that behavior back by mixing in trait LegacyTripleEquals.

    condition

    the boolean condition to assert

    clue

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

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
    Exceptions thrown
    NullPointerException

    if message is null.

    TestFailedException

    if the condition is false.

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

    This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

    • assert(a == b)
    • assert(a != b)
    • assert(a === b)
    • assert(a !== b)
    • assert(a > b)
    • assert(a >= b)
    • assert(a < b)
    • assert(a <= b)
    • assert(a startsWith "prefix")
    • assert(a endsWith "postfix")
    • assert(a contains "something")
    • assert(a eq b)
    • assert(a ne b)
    • assert(a > 0 && b > 5)
    • assert(a > 0 || b > 5)
    • assert(a.isEmpty)
    • assert(!a.isEmpty)
    • assert(a.isInstanceOf[String])
    • assert(a.length == 8)
    • assert(a.size == 8)
    • assert(a.exists(_ == 8))

    At this time, any other form of expression will get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean, not Option[String] to be the default in tests. This makes === consistent between tests and production code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String], use can get that behavior back by mixing in trait LegacyTripleEquals.

    condition

    the boolean condition to assert

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
    Exceptions thrown
    TestFailedException

    if the condition is false.

  28. def assertCompiles(code: String): Unit

    Asserts that a given string snippet of code passes both the Scala parser and type checker.

    Asserts that a given string snippet of code passes both the Scala parser and type checker.

    You can use this to make sure a snippet of code compiles:

    assertCompiles("val a: Int = 1")
    

    Although assertCompiles is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string compiles, errors (i.e., snippets of code that do not compile) are reported as test failures at runtime.

    code

    the snippet of code that should compile

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
  29. def assertDoesNotCompile(code: String): Unit

    Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

    Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

    Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

    assertDoesNotCompile("val a: String = \"a string")
    

    Although assertDoesNotCompile is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string doesn't compile, errors (i.e., snippets of code that do compile) are reported as test failures at runtime.

    Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

    code

    the snippet of code that should not type check

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
  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 assertTypeError(code: String): Unit

    Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

    Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

    Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

    assertTypeError("val a: String = 1")
    

    Although assertTypeError is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string type checks, errors (i.e., snippets of code that do type check) are reported as test failures at runtime.

    Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

    code

    the snippet of code that should not type check

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
  33. val assertionsHelper: AssertionsHelper

    Helper instance used by code generated by macro assertion.

    Helper instance used by code generated by macro assertion.

    Definition Classes
    Assertions
  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 a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

    This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

    • assume(a == b, "a good clue")
    • assume(a != b, "a good clue")
    • assume(a === b, "a good clue")
    • assume(a !== b, "a good clue")
    • assume(a > b, "a good clue")
    • assume(a >= b, "a good clue")
    • assume(a < b, "a good clue")
    • assume(a <= b, "a good clue")
    • assume(a startsWith "prefix", "a good clue")
    • assume(a endsWith "postfix", "a good clue")
    • assume(a contains "something", "a good clue")
    • assume(a eq b, "a good clue")
    • assume(a ne b, "a good clue")
    • assume(a > 0 && b > 5, "a good clue")
    • assume(a > 0 || b > 5, "a good clue")
    • assume(a.isEmpty, "a good clue")
    • assume(!a.isEmpty, "a good clue")
    • assume(a.isInstanceOf[String], "a good clue")
    • assume(a.length == 8, "a good clue")
    • assume(a.size == 8, "a good clue")
    • assume(a.exists(_ == 8), "a good clue")

    At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean, not Option[String] to be the default in tests. This makes === consistent between tests and production code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String], use can get that behavior back by mixing in trait LegacyTripleEquals.

    condition

    the boolean condition to assume

    clue

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

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
    Exceptions thrown
    NullPointerException

    if message is null.

    TestCanceledException

    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.

    This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

    • assume(a == b)
    • assume(a != b)
    • assume(a === b)
    • assume(a !== b)
    • assume(a > b)
    • assume(a >= b)
    • assume(a < b)
    • assume(a <= b)
    • assume(a startsWith "prefix")
    • assume(a endsWith "postfix")
    • assume(a contains "something")
    • assume(a eq b)
    • assume(a ne b)
    • assume(a > 0 && b > 5)
    • assume(a > 0 || b > 5)
    • assume(a.isEmpty)
    • assume(!a.isEmpty)
    • assume(a.isInstanceOf[String])
    • assume(a.length == 8)
    • assume(a.size == 8)
    • assume(a.exists(_ == 8))

    At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean, not Option[String] to be the default in tests. This makes === consistent between tests and production code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String], use can get that behavior back by mixing in trait LegacyTripleEquals.

    condition

    the boolean condition to assume

    Definition Classes
    Assertions
    Annotations
    @macroImpl()
    Exceptions thrown
    TestCanceledException

    if the condition is false.

  36. def atLeast(num: Int, xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    atLeast(1, str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  37. def atLeast[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    atLeast(1, jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  38. def atLeast[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    atLeast(1, xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  39. def atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfAtLeastOneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  40. def atMost(num: Int, xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    atMost(3, str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  41. def atMost[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    atMost(3, jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  42. def atMost[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    atMost(3, xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  43. def atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfAtMostOneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) should contain (atMostOneOf(1, 2))
                                  ^
    

    Definition Classes
    Matchers
  44. val be: BeWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
                ^
    

    Definition Classes
    MatcherWords
  45. def between(from: Int, upTo: Int, xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    between(1, 3, str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  46. def between[K, V, JMAP[k, v] <: Map[k, v]](from: Int, upTo: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    between(1, 3, jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  47. def between[E, C[_]](from: Int, upTo: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    between(1, 3, xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  48. 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

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

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

  51. def cancel(): Nothing

    Throws TestCanceledException to indicate a test was canceled.

    Throws TestCanceledException to indicate a test was canceled.

    Definition Classes
    Assertions
  52. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  53. val compile: CompileWord

    This field enables the following syntax:

    This field enables the following syntax:

    "val a: String = 1" shouldNot compile
                                  ^
    

    Definition Classes
    MatcherWords
  54. val contain: ContainWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    list should (contain ('a') and have length (7))
                 ^
    

    Definition Classes
    MatcherWords
  55. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): Constraint[A, B]

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

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

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

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

    equivalenceOfA

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

    cnv

    an implicit conversion from B to A

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  56. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): Constraint[A, B]

    Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

    Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

    This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B.

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

    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.

    equivalenceOfB

    an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

    ev

    evidence that A is a subype of B

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  57. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): Constraint[A, B]

    Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an explicit Equivalence[B].

    Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an explicit Equivalence[B].

    This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that converts from A to B.

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

    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.

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  58. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): Constraint[A, B]

    Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

    Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

    This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B. For example, under TypeCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

    def closeEnoughTo1(num: Double): Boolean =
      (num === 1.0)(decided by forgivingEquality)
    

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

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

    ev

    evidence that B is a subype of A

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  59. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): Constraint[A, B]

    Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an explicit Equivalence[A].

    Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an explicit Equivalence[A].

    This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[A], but taking an implicit function that converts from B to A. For example, under ConversionCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

    def closeEnoughTo1(num: Double): Boolean =
      (num === 1.0)(decided by forgivingEquality)
    

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

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

    equivalenceOfA

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

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  60. 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
  61. implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol): HavePropertyMatcherGenerator

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

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

    Definition Classes
    Matchers
  62. implicit def convertToAnyShouldWrapper[T](o: T): AnyShouldWrapper[T]

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

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

    Definition Classes
    Matchers
  63. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

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

    Converts 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
    TripleEqualsTripleEqualsSupport
    Exceptions thrown
    NullPointerException

    if left is null.

  64. implicit def convertToEqualizer[T](left: T): Equalizer[T]

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

    Converts 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
    TripleEqualsTripleEqualsSupport
    Exceptions thrown
    NullPointerException

    if left is null.

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

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

    Converts 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
    TripleEqualsTripleEqualsSupport
    Exceptions thrown
    NullPointerException

    if left is null.

  66. def convertToLegacyEqualizer[T](left: T): LegacyEqualizer[T]

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

    Converts 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
    TripleEqualsTripleEqualsSupport
    Exceptions thrown
    NullPointerException

    if left is null.

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

    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.

    Definition Classes
    Matchers
  68. implicit def convertToStringShouldWrapper(o: String): StringShouldWrapper

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

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

    Definition Classes
    MatchersShouldVerb
  69. val decided: DecidedWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    result should equal ("hello") (decided by defaultEquality)
                                   ^
    

    Definition Classes
    Explicitly
  70. def defaultEquality[A]: Equality[A]

    Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

    Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

    returns

    a default Equality for type A

    Definition Classes
    TripleEqualsSupport
  71. val defined: DefinedWord

    This field enables the following syntax:

    This field enables the following syntax:

    seq should be (defined)
                  ^
    

    Definition Classes
    MatcherWords
  72. def definedAt[T](right: T): ResultOfDefinedAt[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  73. val determined: DeterminedWord

    This field enables syntax such as the following, given an Equivalence[String] named myStringEquivalence:

    This field enables syntax such as the following, given an Equivalence[String] named myStringEquivalence:

    result should equal ("hello") (determined by myStringEquivalence)
                                   ^
    

    Definition Classes
    Explicitly
  74. val empty: EmptyWord

    This field enables the following syntax:

    This field enables the following syntax:

    list should be (empty)
                    ^
    

    Definition Classes
    MatcherWords
  75. val endWith: EndWithWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    string should (endWith ("ago") and include ("score"))
                   ^
    

    Definition Classes
    MatcherWords
  76. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  77. def equal(o: Null): Matcher[AnyRef]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should equal (null)
                  ^
    

    Definition Classes
    Matchers
  78. def equal[T](spread: Spread[T]): Matcher[T]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should equal (100 +- 1)
                  ^
    

    Definition Classes
    Matchers
  79. 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
  80. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  81. def every(xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    every(str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  82. def every[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    every(jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  83. def every[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    every(xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  84. def exactly(num: Int, xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    exactly(str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  85. def exactly[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    exactly(jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  86. def exactly[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    exactly(xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  87. val exist: ExistWord

    This field enables the following syntax:

    This field enables the following syntax:

    file should exist
                ^
    

    Definition Classes
    MatcherWords
  88. 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

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

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

  91. def fail(): Nothing

    Throws TestFailedException to indicate a test failed.

    Throws TestFailedException to indicate a test failed.

    Definition Classes
    Assertions
  92. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  93. val fullyMatch: FullyMatchWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99))
                   ^
    

    Definition Classes
    MatcherWords
  94. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  95. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  96. val have: HaveWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    list should (have length (3) and not contain ('a'))
                 ^
    

    Definition Classes
    MatcherWords
  97. def inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfInOrderApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  98. def inOrderOnly[T](firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfInOrderOnlyApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  99. val include: IncludeWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    string should (include ("hope") and not startWith ("no"))
                   ^
    

    Definition Classes
    MatcherWords
  100. 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.

  101. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  102. val key: KeyWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain key (10)
                           ^
    

    Definition Classes
    Matchers
  103. val length: LengthWord

    This field enables the following syntax:

    This field enables the following syntax:

    "hi" should not have length (3)
                         ^
    

    Definition Classes
    MatcherWords
  104. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): Constraint[A, B]

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

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

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

    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

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  105. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): Constraint[A, B]

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

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

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

    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.

    equivalenceOfB

    an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

    ev

    evidence that A is a subype of B

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  106. val matchPattern: MatchPatternWord

    This field enables the following syntax:

    This field enables the following syntax:

    result should matchPattern { case Person("Bob", _) => }
                  ^
    

    Definition Classes
    MatcherWords
  107. def message(expectedMessage: String): ResultOfMessageWordApplication

    This method enables the following syntax:

    This method enables the following syntax:

    exception should not have message ("file not found")
                              ^
    

    Definition Classes
    Matchers
  108. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  109. def no(xs: String)(implicit collecting: Collecting[Char, String]): ResultOfCollectedAny[Char]

    This method enables the following syntax for String:

    This method enables the following syntax for String:

    no(str) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  110. def no[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]]): ResultOfCollectedAny[Entry[K, V]]

    This method enables the following syntax for java.util.Map:

    This method enables the following syntax for java.util.Map:

    no(jmap) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  111. def no[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]]): ResultOfCollectedAny[E]

    This method enables the following syntax:

    This method enables the following syntax:

    no(xs) should fullymatch regex ("Hel*o world".r)
    ^
    

    Definition Classes
    Matchers
  112. val noException: NoExceptionWord

    This field enables the following syntax:

    This field enables the following syntax:

    noException should be thrownBy
    ^
    

    Definition Classes
    MatcherWords
  113. def noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfNoneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  114. 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
  115. final def notify(): Unit

    Definition Classes
    AnyRef
  116. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  117. def of[T](implicit ev: Manifest[T]): ResultOfOfTypeInvocation[T]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    book should have (message ("A TALE OF TWO CITIES") (of [Book]), title ("A Tale of Two Cities"))
                                                        ^
    

    Definition Classes
    Matchers
  118. def oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*): ResultOfOneOfApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  119. def only(xs: Any*): ResultOfOnlyApplication

    This method enables the following syntax:

    This method enables the following syntax:

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

    Definition Classes
    Matchers
  120. def produce[T](implicit arg0: 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
  121. val readable: ReadableWord

    This field enables the following syntax:

    This field enables the following syntax:

    file should be (readable)
                    ^
    

    Definition Classes
    MatcherWords
  122. 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
  123. val size: SizeWord

    This field enables the following syntax:

    This field enables the following syntax:

    set should not have size (3)
                        ^
    

    Definition Classes
    MatcherWords
  124. val sorted: SortedWord

    This field enables the following syntax:

    This field enables the following syntax:

    seq should be (sorted)
                  ^
    

    Definition Classes
    MatcherWords
  125. val startWith: StartWithWord

    This field enables syntax such as the following:

    This field enables syntax such as the following:

    string should (startWith ("Four") and include ("year"))
                   ^
    

    Definition Classes
    MatcherWords
  126. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  127. def the[T](implicit arg0: Manifest[T]): ResultOfTheTypeInvocation[T]

    This method enables the following syntax:

    This method enables the following syntax:

    the [FileNotFoundException] should be thrownBy { ... }
    ^
    

    Definition Classes
    Matchers
  128. def theSameElementsAs(xs: GenTraversable[_]): ResultOfTheSameElementsAsApplication

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) should contain (theSameElementsAs(List(1, 2, 3)))
                                  ^
    

    Definition Classes
    Matchers
  129. def theSameElementsInOrderAs(xs: GenTraversable[_]): ResultOfTheSameElementsInOrderAsApplication

    This method enables the following syntax:

    This method enables the following syntax:

    List(1, 2, 3) should contain (theSameElementsInOrderAs(List(1, 2)))
                                  ^
    

    Definition Classes
    Matchers
  130. val theSameInstanceAs: TheSameInstanceAsPhrase

    This field enables the following syntax:

    This field enables the following syntax:

    oneString should not be theSameInstanceAs (anotherString)
                            ^
    

    Definition Classes
    Matchers
  131. def thrownBy(fun: ⇒ Any): ResultOfThrownByApplication

    This method enables the following syntax:

    This method enables the following syntax:

    a [RuntimeException] should be thrownBy {...}
                                   ^
    

    Definition Classes
    Matchers
  132. def toString(): String

    Definition Classes
    AnyRef → Any
  133. def trap[T](f: ⇒ T): Throwable

    Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

    Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

    This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected exception, use intercept, not trap. Here's an example interpreter session without trap:

    scala> import org.scalatest._
    import org.scalatest._

    scala> import Matchers._ import Matchers._

    scala> val x = 12 a: Int = 12

    scala> x shouldEqual 13 org.scalatest.exceptions.TestFailedException: 12 did not equal 13 at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449) at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203) at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417) at .<init>(<console>:15) at .<clinit>(<console>) at .<init>(<console>:7) at .<clinit>(<console>) at $print(<console>) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731) at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980) at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565) at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745) at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790) at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702) at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566) at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573) at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135) at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822) at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83) at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)

    That's a pretty tall stack trace. Here's what it looks like when you use trap:

    scala> trap { x shouldEqual 13 }
    res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13
    

    Much less clutter. Bear in mind, however, that if no exception is thrown by the passed block of code, the trap method will create a new NormalResult (a subclass of Throwable made for this purpose only) and return that. If the result was the Unit value, it will simply say that no exception was thrown:

    scala> trap { x shouldEqual 12 }
    res2: Throwable = No exception was thrown.
    

    If the passed block of code results in a value other than Unit, the NormalResult's toString will print the value:

    scala> trap { "Dude!" }
    res3: Throwable = No exception was thrown. Instead, result was: "Dude!"
    

    Although you can access the result value from the NormalResult, its type is Any and therefore not very convenient to use. It is not intended that trap be used in test code. The sole intended use case for trap is decluttering Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.

    Definition Classes
    Assertions
  134. val typeCheck: TypeCheckWord

    This field enables the following syntax:

    This field enables the following syntax:

    "val a: String = 1" shouldNot typeCheck
                                  ^
    

    Definition Classes
    MatcherWords
  135. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): Constraint[A, B]

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

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

    The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

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

    ev

    evidence that B is a subype of A

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  136. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): Constraint[A, B]

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

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

    The returned Constraint's areEqual method uses the implicitly passed Equality[A]'s areEqual method to determine equality.

    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 Constraint.areEqual method will delegate to determine equality.

    returns

    a Constraint[A, B] whose areEqual method delegates to the areEqual method of the passed Equality[A].

    Definition Classes
    TripleEqualsTripleEqualsSupport
  137. val value: ValueWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain value (10)
                           ^
    

    Definition Classes
    Matchers
  138. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  141. 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

  142. val writable: WritableWord

    This field enables the following syntax:

    This field enables the following syntax:

    file should be (writable)
                    ^
    

    Definition Classes
    MatcherWords

Deprecated Value Members

  1. 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
    Annotations
    @deprecated
    Deprecated

    This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.

    Exceptions thrown
    TestFailedException

    if the Option[String] is Some.

  2. 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 object whose toString method returns a message to include in a failure report.

    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.

    Exceptions thrown
    NullPointerException

    if message is null.

    TestFailedException

    if the Option[String] is Some.

  3. 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:

    assume(a === b)
    

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

    o

    the Option[String] to assert

    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.

    Exceptions thrown
    TestCanceledException

    if the Option[String] is Some.

  4. 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 object whose toString method returns a message to include in a failure report.

    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.

    Exceptions thrown
    NullPointerException

    if message is null.

    TestCanceledException

    if the Option[String] is Some.

  5. def evaluating(fun: ⇒ Any): ResultOfEvaluatingApplication

    The evaluating { ... } should produce [...Exception] syntax has been deprecated and will be removed in a future version of ScalaTest. Please use a/an [...Exception] should be thrownBy { ... } instead.

    The evaluating { ... } should produce [...Exception] syntax has been deprecated and will be removed in a future version of ScalaTest. Please use a/an [...Exception] should be thrownBy { ... } instead.

    This method enables syntax such as the following:

    evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException]
    ^
    

    Definition Classes
    Matchers
    Annotations
    @deprecated
    Deprecated

    Please use 'an [Exception] should be thrownBy { ... }' syntax instead

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

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

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

    To get rid of the deprecation warning, simply replace expect with assertResult. 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 assertResult instead.

  7. def expect(expected: Any, clue: Any)(actual: Any): Unit

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

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

    To get rid of the deprecation warning, simply replace expect with assertResult. 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 assertResult instead.

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

  9. 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 Matchers

Inherited from Explicitly

Inherited from MatcherWords

Inherited from ShouldVerb

Inherited from Tolerance

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped