org.scalatest.matchers.Matchers

# MatcherWrapper

#### class MatcherWrapper[T] extends AnyRef

This class is part of the ScalaTest matchers DSL. Please see the documentation for `ShouldMatchers` or `MustMatchers` for an overview of the matchers DSL.

attributes: final

authors:

1. Bill Venners

Inherited

1. Hide All
2. Show all

1. AnyRef
2. Any

Visibility

1. Public
2. All

### Instance constructors

1. #### new MatcherWrapper(leftMatcher: Matcher[T])

### Type Members

1. #### class AndBeWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

2. #### class AndContainWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

3. #### class AndEndWithWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

4. #### class AndFullyMatchWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

5. #### class AndHaveWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

6. #### class AndIncludeWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

7. #### class AndNotWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

8. #### class AndStartWithWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

9. #### class OrBeWord extends AnyRef

   This class is part of the ScalaTest matchers DSL.

10. #### class OrContainWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

11. #### class OrEndWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

12. #### class OrFullyMatchWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

13. #### class OrHaveWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

14. #### class OrIncludeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

15. #### class OrNotWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

16. #### class OrStartWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

### Value Members

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

   attributes: final
   definition classes: AnyRef

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

   `o != arg0` is the same as `!(o == (arg0))`.

   `o != arg0` is the same as `!(o == (arg0))`.

   arg0

     the object to compare against this object for dis-equality.

   returns

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

   attributes: final
   definition classes: Any

3. #### def ##(): Int

   attributes: final
   definition classes: AnyRef → Any

4. #### def $asInstanceOf[T0](): T0

   attributes: final
   definition classes: AnyRef

5. #### def $isInstanceOf[T0](): Boolean

   attributes: final
   definition classes: AnyRef

6. #### def ==(arg0: AnyRef): Boolean

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

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

   attributes: final
   definition classes: AnyRef

7. #### def ==(arg0: Any): Boolean

   `o == arg0` is the same as `o.equals(arg0)`.

   `o == arg0` is the same as `o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

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

   attributes: final
   definition classes: Any

8. #### def and(notWord: NotWord): AndNotWord

   This method enables the following syntax:

   This method enables the following syntax:

       Map("one" -> 1, "two" -> 2) should (not contain value (5) and not contain value (3))

9. #### def and(endWithWord: EndWithWord): AndEndWithWord

   This method enables the following syntax:

   This method enables the following syntax:

       "1.7" should (endWith regex (decimalRegex) and endWith regex (decimalRegex))

10. #### def and(startWithWord: StartWithWord): AndStartWithWord

    This method enables the following syntax:

    This method enables the following syntax:

        "1.78" should (have length (4) and startWith regex ("1.7"))

11. #### def and(includeWord: IncludeWord): AndIncludeWord

    This method enables the following syntax:

    This method enables the following syntax:

        "hello, world" should (include regex ("hel*o") and include regex ("wor.d"))

12. #### def and(fullyMatchWord: FullyMatchWord): AndFullyMatchWord

    This method enables the following syntax:

    This method enables the following syntax:

        "1.7" should (fullyMatch regex (decimalRegex) and fullyMatch regex (decimalRegex))

13. #### def and(beWord: BeWord): AndBeWord

    This method enables the following syntax:

    This method enables the following syntax:

        isFileMock should (be a ('file) and be a ('file))

14. #### def and(containWord: ContainWord): AndContainWord

    This method enables the following syntax:

    This method enables the following syntax:

        Map("one" -> 1, "two" -> 2) should (contain key ("two") and contain key ("one"))

15. #### def and(haveWord: HaveWord): AndHaveWord

    This method enables the following syntax:

    This method enables the following syntax:

        Array(1, 2) should (have size (2) and have size (3 - 1))

16. #### def and[U <: T](rightMatcher: Matcher[U]): Matcher[U]

    Returns a matcher whose `apply` method returns a `MatchResult`that represents the logical-and of the results of the wrapped and the passed matcher applied to the same value.

    Returns a matcher whose `apply` method returns a `MatchResult`that represents the logical-and of the results of the wrapped and the passed matcher applied to the same value.

    The reason `and` has an upper bound on its type parameter is so that the `Matcher`resulting from an invocation of `and` will have the correct type parameter. If you call`and` on a `Matcher[Orange]`, passing in a `Matcher[Valencia]`, the result will have type `Matcher[Valencia]`. This is correct because both a`Matcher[Orange]` and a `Matcher[Valencia]` know how to match a`Valencia` (but a `Matcher[Valencia]` doesn't know how to match any old `Orange`). If you call`and` on a `Matcher[Orange]`, passing in a `Matcher[Fruit]`, the result will have type `Matcher[Orange]`. This is also correct because both a`Matcher[Orange]` and a `Matcher[Fruit]` know how to match an`Orange` (but a `Matcher[Orange]` doesn't know how to match any old `Fruit`).

    returns

      a matcher that performs the logical-and of this and the passed matcher

17. #### def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type `T0`.

    This method is used to cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      the receiver object.

    attributes: final
    definition classes: Any

18. #### def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef

19. #### def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

    Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    arg0

      the object to compare against this object for reference equality.

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    attributes: final
    definition classes: AnyRef

20. #### def equals(arg0: Any): Boolean

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

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

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`. * It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. * It is transitive: for any instances `x`, `y`, and `z` of type `AnyRef` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

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

    arg0

      the object to compare against this object for equality.

    returns

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

    definition classes: AnyRef → Any

21. #### def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

22. #### def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

23. #### def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

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

    returns

      the hash code value for the object.

    definition classes: AnyRef → Any

24. #### def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    attributes: final
    definition classes: Any

25. #### def ne(arg0: AnyRef): Boolean

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    arg0

      the object to compare against this object for reference dis-equality.

    returns

      `false` if the argument is not a reference to the receiver object; `true` otherwise.

    attributes: final
    definition classes: AnyRef

26. #### def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

27. #### def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

28. #### def or(notWord: NotWord): OrNotWord

    This method enables the following syntax:

    This method enables the following syntax:

        Map("one" -> 1, "two" -> 2) should (not contain value (2) or not contain value (3))

29. #### def or(endWithWord: EndWithWord): OrEndWithWord

    This method enables the following syntax:

    This method enables the following syntax:

        "1.7b" should (endWith regex ("hello") or endWith regex ("7b"))

30. #### def or(startWithWord: StartWithWord): OrStartWithWord

    This method enables the following syntax:

    This method enables the following syntax:

        "1.7" should (startWith regex ("hello") or startWith regex ("1.7"))

31. #### def or(includeWord: IncludeWord): OrIncludeWord

    This method enables the following syntax:

    This method enables the following syntax:

        "a1.7b" should (include regex ("1.7") or include regex ("1.7"))

32. #### def or(fullyMatchWord: FullyMatchWord): OrFullyMatchWord

    This method enables the following syntax:

    This method enables the following syntax:

        "1.7" should (fullyMatch regex ("hello") or fullyMatch regex (decimal))

33. #### def or(beWord: BeWord): OrBeWord

    This method enables the following syntax:

    This method enables the following syntax:

        isFileMock should (be a ('file) or be a ('directory))

34. #### def or(containWord: ContainWord): OrContainWord

    This method enables the following syntax:

    This method enables the following syntax:

        Map("one" -> 1, "two" -> 2) should (contain value (7) or contain value (1))

35. #### def or(haveWord: HaveWord): OrHaveWord

    This method enables the following syntax:

    This method enables the following syntax:

        Array(1, 2) should (have size (2) and have size (3 - 1))

36. #### def or[U <: T](rightMatcher: Matcher[U]): Matcher[U]

    Returns a matcher whose `apply` method returns a `MatchResult`that represents the logical-or of the results of this and the passed matcher applied to the same value.

    Returns a matcher whose `apply` method returns a `MatchResult`that represents the logical-or of the results of this and the passed matcher applied to the same value.

    The reason `or` has an upper bound on its type parameter is so that the `Matcher`resulting from an invocation of `or` will have the correct type parameter. If you call`or` on a `Matcher[Orange]`, passing in a `Matcher[Valencia]`, the result will have type `Matcher[Valencia]`. This is correct because both a`Matcher[Orange]` and a `Matcher[Valencia]` know how to match a`Valencia` (but a `Matcher[Valencia]` doesn't know how to match any old `Orange`). If you call`or` on a `Matcher[Orange]`, passing in a `Matcher[Fruit]`, the result will have type `Matcher[Orange]`. This is also correct because both a`Matcher[Orange]` and a `Matcher[Fruit]` know how to match an`Orange` (but a `Matcher[Orange]` doesn't know how to match any old `Fruit`).

    returns

      a matcher that performs the logical-or of this and the passed matcher

37. #### def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

38. #### def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    definition classes: AnyRef → Any

39. #### def wait(): Unit

    attributes: final
    definition classes: AnyRef

40. #### def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

41. #### def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef