org.scalatest

# matchers

#### package matchers

Visibility

1. Public
2. All

### Type Members

1. #### trait BeMatcher [-T] extends (T) ⇒ MatchResult

   Trait extended by matcher objects, which may appear after the word `be`, that can match a value of the specified type.

2. #### case class BePropertyMatchResult (matches: Boolean, propertyName: String) extends Product with Serializable

   The result of a `Boolean` property match operation, such as one performed by a `BePropertyMatcher`, which contains one field that indicates whether the match succeeded (i.e., the `Boolean` property was `true`) and one field that provides the name of the property.

3. #### trait BePropertyMatcher [-T] extends (T) ⇒ BePropertyMatchResult

   Trait extended by matcher objects, which may appear after the word `be`, that can match against a `Boolean` property.

4. #### case class HavePropertyMatchResult [P] (matches: Boolean, propertyName: String, expectedValue: P, actualValue: P) extends Product with Serializable

   The result of a property match operation such as one performed by a `HavePropertyMatcher`, which contains one field that indicates whether the match succeeded (i.e., the property had its expected value), one field that provides the name of the property, and two fields giving the expected and actual values.

5. #### trait HavePropertyMatcher [-T, P] extends (T) ⇒ HavePropertyMatchResult[P]

   Trait extended by matcher objects, which may appear after the word `have`, that can match against a property of the type specified by the `HavePropertyMatcher`'s second type parameter `P`.

6. #### case class MatchResult (matches: Boolean, failureMessage: String, negatedFailureMessage: String, midSentenceFailureMessage: String, midSentenceNegatedFailureMessage: String) extends Product with Serializable

   The result of a match operation, such as one performed by a `Matcher` or `BeMatcher`, which contains one field that indicates whether the match succeeded and four fields that provide failure messages to report under different circumstances.

7. #### trait Matcher [-T] extends (T) ⇒ MatchResult

   Trait extended by objects that can match a value of the specified type.

8. #### trait Matchers extends Assertions

   This trait is part of the ScalaTest matchers DSL.

9. #### trait MustMatchers extends Matchers with MustVerb

   Trait that provides a domain specific language (DSL) for expressing assertions in tests using the word `must`.

10. #### trait ShouldMatchers extends Matchers with ShouldVerb

    Trait that provides a domain specific language (DSL) for expressing assertions in tests using the word `should`.

### Value Members

1. #### object BeMatcher extends AnyRef

   Companion object for trait `BeMatcher` that provides a factory method that creates a `BeMatcher[T]` from a passed function of type `(T => MatchResult)`.

2. #### object BePropertyMatchResult extends Serializable

   Companion object for the `BePropertyMatchResult` case class.

3. #### object BePropertyMatcher extends AnyRef

   Companion object for trait `BePropertyMatcher` that provides a factory method that creates a `BePropertyMatcher[T]` from a passed function of type `(T => BePropertyMatchResult)`.

4. #### object HavePropertyMatchResult extends Serializable

   Companion object for the `HavePropertyMatchResult` case class.

5. #### object HavePropertyMatcher extends AnyRef

   Companion object for trait `HavePropertyMatcher` that provides a factory method that creates a `HavePropertyMatcher[T]` from a passed function of type `(T => HavePropertyMatchResult)`.

6. #### object MatchResult extends Serializable

   Companion object for the `MatchResult` case class.

7. #### object Matcher extends AnyRef

   Companion object for trait `Matcher` that provides a factory method that creates a `Matcher[T]` from a passed function of type `(T => MatchResult)`.

8. #### object MustMatchers extends MustMatchers

   Companion object that facilitates the importing of `MustMatchers` members as an alternative to mixing it the trait.

9. #### object ShouldMatchers extends ShouldMatchers

   Companion object that facilitates the importing of `ShouldMatchers` members as an alternative to mixing it the trait.