scalatestMatchersCoreDotty/org.scalatest.matchers.dsl/ContainWord

ContainWord

final class ContainWord

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

class Object
trait Matchable
class Any

Value members

Concrete methods

infix def allElementsOf(elements: Iterable[Any]): MatcherFactory1[Any, Aggregating]
infix def allOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
def apply(nullValue: Null): MatcherFactory1[Any, Containing]

This method enables the following syntax:

This method enables the following syntax:

list should contain (null)
                   ^
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))
                           ^
infix def atLeastOneElementOf(elements: Iterable[Any]): MatcherFactory1[Any, Aggregating]
infix def atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
infix def atMostOneElementOf(elements: Iterable[Any]): MatcherFactory1[Any, Aggregating]
infix def atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
infix def inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Sequencing]
infix def inOrderElementsOf(elements: Iterable[Any]): MatcherFactory1[Any, Sequencing]
infix def inOrderOnly(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Sequencing]
infix 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.

infix def noElementsOf(elements: Iterable[Any]): MatcherFactory1[Any, Containing]
infix def noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Containing]
infix def oneElementOf(elements: Iterable[Any]): MatcherFactory1[Any, Containing]
infix def oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Containing]
infix def only(right: Any*)(implicit prettifier: Prettifier, pos: Position): MatcherFactory1[Any, Aggregating]
infix def theSameElementsAs(right: Iterable[Any]): MatcherFactory1[Any, Aggregating]
infix def theSameElementsInOrderAs(right: Iterable[Any]): MatcherFactory1[Any, Sequencing]
override def toString: String

Overrides toString to return "contain"

Overrides toString to return "contain"

Definition Classes
Any
infix 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.