ShouldMatchers

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

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

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

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

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

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.

final def ##(): Int

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

This method enables the following syntax:

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

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

This method enables the following syntax:

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

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

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

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

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

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

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.

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

This method enables the following syntax:

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

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

This method enables the following syntax:

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

val a: AWord

This field enables the following syntax:

badBook should not be a ('goodRead)
                      ^

val after: TheAfterWord

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

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

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

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

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

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

This method enables the following syntax:

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

val an: AnWord

This field enables the following syntax:

badBook should not be an (excellentRead)
                      ^

final def asInstanceOf[T0]: T0

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

Assert that an Option[String] is None.

assert(a === b)

def assert(o: Option[String], clue: Any): Unit

Assert that an Option[String] is None.

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

def assert(condition: Boolean, clue: Any): Unit

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

def assert(condition: Boolean): Unit

Assert that a boolean condition is true.

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

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

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

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

def assume(o: Option[String]): Unit

Assume that an Option[String] is None.

assert(a === b)

def assume(o: Option[String], clue: Any): Unit

Assume that an Option[String] is None.

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

def assume(condition: Boolean, clue: Any): Unit

Assume that a boolean condition, described in String message, is true.

def assume(condition: Boolean): Unit

Assume that a boolean condition is true.

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

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

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

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

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

def atLeastOneOf(xs: Any*): ResultOfAtLeastOneOfApplication

This method enables the following syntax:

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

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

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

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

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

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

val be: BeWord

This method enables syntax such as the following:

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

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

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

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

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

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

def cancel(cause: Throwable): Nothing

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

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.

def cancel(message: String): Nothing

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

def cancel(): Nothing

Throws TestCanceledException to indicate a test was canceled.

def clone(): AnyRef

val contain: ContainWord

This method enables syntax such as the following:

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

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

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

implicit def convertMapMatcherToJavaMapMatcher[K, V](mapMatcher: Matcher[GenMap[K, V]]): Matcher[Map[K, V]]

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

javaMap should (contain key ("two"))

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.

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.

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.

implicit def convertToArrayShouldWrapper[T](o: Array[T]): ArrayShouldWrapper[T]

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

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

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

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

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

implicit def convertToJavaCollectionShouldWrapper[E, L[_] <: Collection[_]](o: L[E]): JavaCollectionShouldWrapper[E, L]

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

implicit def convertToJavaMapShouldWrapper[K, V, L[_, _] <: Map[_, _]](o: L[K, V]): JavaMapShouldWrapper[K, V, L]

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

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

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

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

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

implicit def convertToMapShouldWrapper[K, V, L[_, _] <: GenMap[_, _]](o: L[K, V]): MapShouldWrapper[K, V, L]

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

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.

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.

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

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

implicit def convertToTraversableShouldWrapper[E, L[_] <: GenTraversable[_]](o: L[E]): TraversableShouldWrapper[E, L]

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

implicit def convertTraversableMatcherToArrayMatcher[T](traversableMatcher: Matcher[GenTraversable[T]]): Matcher[Array[T]]

This implicit conversion method enables the following syntax:

Array(1, 2) should (not contain (3) and not contain (2))

implicit def convertTraversableMatcherToJavaCollectionMatcher[T](traversableMatcher: Matcher[GenTraversable[T]]): Matcher[Collection[T]]

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

javaColl should contain ("two")

val decided: DecidedWord

implicit def defaultEquality[A]: Equality[A]

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

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

This method enables the following syntax:

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

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

val endWith: EndWithWord

This method enables syntax such as the following:

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

final def eq(arg0: AnyRef): Boolean

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

This method enables syntax such as the following:

result should equal (null)
       ^

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

This method enables syntax such as the following:

result should equal (100 +- 1)
              ^

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

This method enables the following syntax:

result should equal (7)
              ^

Array(1, 2) == Array(1, 2) // yields false

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

def equals(arg0: Any): Boolean

def evaluating(fun: ⇒ Any): ResultOfEvaluatingApplication

This method enables syntax such as the following:

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

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

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

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

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

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

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

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

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

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

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

def fail(cause: Throwable): Nothing

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

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.

def fail(message: String): Nothing

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

def fail(): Nothing

Throws TestFailedException to indicate a test failed.

def finalize(): Unit

val fullyMatch: FullyMatchWord

This method enables syntax such as the following:

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

final def getClass(): Class[_]

def hashCode(): Int

val have: HaveWord

This method enables syntax such as the following:

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

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

This method enables the following syntax:

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

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

This method enables the following syntax:

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

val include: IncludeWord

This method enables syntax such as the following:

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

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.

final def isInstanceOf[T0]: Boolean

val key: KeyWord

This field enables the following syntax:

map should not contain key (10)
                       ^

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

val length: LengthWord

This field enables the following syntax:

"hi" should not have length (3)
                     ^

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

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

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

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

final def ne(arg0: AnyRef): Boolean

val newContain: NewContainWord

This method enables syntax such as the following:

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

def newOneOf(xs: Any*): ResultOfNewOneOfApplication

This method enables the following syntax:

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

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

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

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

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

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

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

This method enables the following syntax:

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

val not: NotWord

This field enables syntax like the following:

myFile should (not be an (directory) and not have ('name ("foo.bar")))
               ^

final def notify(): Unit

final def notifyAll(): Unit

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

This method enables the following syntax:

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

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

This method enables the following syntax:

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

def produce[T](implicit manifest: Manifest[T]): ResultOfProduceInvocation[T]

This method enables the following syntax:

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

val regex: RegexWord

This field enables the following syntax:

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

val size: SizeWord

This field enables the following syntax:

set should not have size (3)
                    ^

val startWith: StartWithWord

This method enables syntax such as the following:

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

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

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

This method enables the following syntax:

traversable should contain (theSameElementsAs(array))
                            ^

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

This method enables the following syntax:

traversable should contain (theSameElementsAs(anotherTraversable))
                            ^

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

This method enables the following syntax:

traversable should contain (theSameElementsInOrderAs(array))
                            ^

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

This method enables the following syntax:

traversable should contain (theSameElementsInOrderAs(anotherTraversable))
                            ^

val theSameInstanceAs: TheSameInstanceAsPhrase

This field enables the following syntax:

oneString should not be theSameInstanceAs (anotherString)
                        ^

def toString(): String

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

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

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

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

val value: ValueWord

This field enables the following syntax:

map should not contain value (10)
                       ^

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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.

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

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

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

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

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

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

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

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

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

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