Packages

c

org.scalatest.words

ContainWord

final class ContainWord extends AnyRef

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

Source
ContainWord.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContainWord
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ContainWord()

Value Members

  1. def allElementsOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Aggregating]
  2. def allOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
  3. def apply(expectedElement: Any): MatcherFactory1[Any, Containing]

    This method enables the following syntax:

    This method enables the following syntax:

    Array(1, 2) should (contain (2) and contain (1))
                            ^

  4. def apply(nullValue: Null): MatcherFactory1[Any, Containing]

    This method enables the following syntax:

    This method enables the following syntax:

    list should contain (null)
                    ^

  5. def atLeastOneElementOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Aggregating]
  6. def atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
  7. def atMostOneElementOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Aggregating]
  8. def atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
  9. def inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Sequencing]
  10. def inOrderElementsOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Sequencing]
  11. def inOrderOnly(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Sequencing]
  12. def key[K](expectedKey: Any): MatcherFactory1[Any, KeyMapping]

    This method enables the following syntax:

    This method enables the following syntax:

    map should (contain key ("fifty five") or contain key ("twenty two"))
                    ^

    The map's value type parameter cannot be inferred because only a key type is provided in an expression like (contain key ("fifty five")). The matcher returned by this method matches scala.collection.Maps with the inferred key type and value type Any. Given Map is covariant in its value type, and Matcher is contravariant in its type parameter, a Matcher[Map[Int, Any]], for example, is a subtype of Matcher[Map[Int, String]]. This will enable the matcher returned by this method to be used against any Map that has the inferred key type.

  13. def noElementsOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Containing]
  14. def noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Containing]
  15. def oneElementOf(elements: GenTraversable[Any]): MatcherFactory1[Any, Containing]
  16. def oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Containing]
  17. def only(right: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
  18. def theSameElementsAs(right: GenTraversable[Any]): MatcherFactory1[Any, Aggregating]
  19. def theSameElementsInOrderAs(right: GenTraversable[Any]): MatcherFactory1[Any, Sequencing]
  20. def toString(): String

    Overrides toString to return "contain"

    Overrides toString to return "contain"

    Definition Classes
    ContainWord → AnyRef → Any
  21. def value[K](expectedValue: Any): MatcherFactory1[Any, ValueMapping]

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

    The map's key type parameter cannot be inferred because only a value type is provided in an expression like (contain value (5)). The matcher returned by this method matches scala.collection.Maps with the inferred value type and the existential key type [K] forSome { type K }. Even though Matcher is contravariant in its type parameter, because Map is nonvariant in its key type, a Matcher[Map[Any, Int]], for example, is not a subtype of Matcher[Map[String, Int]], so the key type parameter of the Map returned by this method cannot be Any. By making it an existential type, the Scala compiler will not infer it to anything more specific. This will enable the matcher returned by this method to be used against any Map that has the inferred value type.