org.scalatest.matchers.Matchers

ContainWord

class ContainWord 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

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def apply[T](expectedElement: T): Matcher[Iterable[T]]

    This method enables the following syntax:

    This method enables the following syntax:

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

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

    definition classes: AnyRef ⇐ Any
  4. def key[K](expectedKey: K): Matcher[Map[K, Any]]

    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.

  5. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
  6. def value[V](expectedValue: V): Matcher[scala.collection.Map[_, V]]

    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.

Instance constructors

  1. new ContainWord()