specs2-matcher/org.specs2.matcher/Matcher

Matcher

The Matcher trait is the base trait for any Matcher.

This trait can be extended to provide an appropriate apply method that will check an expectable value a: Expectable[T].

The result of a match is a Result

Matchers can be composed.

Implementation notes:

the parameter to the apply method must be a by-name parameter. This allows some values to be evaluated only when necessary.
However in the implementation of the apply function, it must be taken care of not evaluating the parameter twice. Assigning it to a val is the solution to this issue.

Companion:: object

class Object

trait Matchable

class Any

trait AdaptableMatcher[T]

class EqualityMatcher[T]

class BeEqualTo

class AlwaysMatcher[T]

class BeCloseTo[T]

class BeFalseMatcher

class BeGreaterThan[T]

class BeGreaterThanOrEqualTo[T]

class BeLessThan[T]

class BeLessThanOrEqualTo[T]

class FindMatcher

class FindMatcherPattern

class FindMatcherRegex

class FindMatcherWithGroups

class FindMatcherPatternWithGroups

class BeNull[T]

class BeOneOf[T]

class BeSignificantlyCloseTo[T]

class BeTheSameAs[T]

class BeTrueMatcher

class BetweenMatcher[T]

class ContainWithResult[T]

class ContainWithResultSeq[T]

class ExceptionClassMatcher

class ExceptionMatcher[E]

class NeverMatcher[T]

class OptionLikeCheckedMatcher[T, U]

class LeftCheckedMatcher[T]

class RightCheckedMatcher[T]

class SomeCheckedMatcher[T]

class TryFailureCheckedMatcher[T]

class TrySuccessCheckedMatcher[T]

class OptionLikeMatcher[T, U]

class LeftMatcher[T]

class RightMatcher[T]

class SomeMatcher[T]

class TryFailureMatcher[T]

class TrySuccessMatcher[T]

class OrderingMatcher[T]

class SizedCheckedMatcher[T]

class SizedMatcher[T]

Matcher[T]

Value members

Abstract methods

apply this matcher to an Expectable

Returns:: a Result describing the outcome of the match

Concrete methods

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage) can be applied to an exception

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage aka "trimmed") can be applied to an exception

The dummy value is used to help to disambiguate with the overloaded ^^ function

the logical and between 2 matchers

See also:: Result.and

Returns:: a matcher that needs to eventually match, after 40 retries and a sleep time of 100 milliseconds

Returns:: a matcher that needs to eventually match, after a given number of retries and a sleep time

Value parameters:

sleep: the function applied on the retry number (first is 1)

Returns:

a matcher that needs to eventually match, after a given number of retries and a sleep time

(aResult === expected).eventually(retries = 2, _ * 100.milliseconds)

when the condition is true the matcher is applied, when it's false, the matcher must fail

The lazily operator returns a Matcher which will match a function returning the expected value

Returns:: a Matcher with no messages

negate a Matcher

See also:: Result.not

the logical or between 2 matchers

See also:: Result.or

Returns:: a Pending Result if this matcher fails

Returns:: a Pending Result if this matcher fails, prefixing the failure message with a pending message. If the pending message is empty, only the failure message is printed

Returns:: a Pending Result if this matcher fails, modifying the failure message with a pending message.

Returns:: a Skipped result if this matcher fails

Returns:: a Skipped Result if this matcher fails, prefixing the failure message with a skip message. If the skip message is empty, only the failure message is printed

Returns:: a Skipped Result if this matcher fails, modifying the failure message with a skip message.

throw a FailureException if this matcher fails

throw a FailureException if this matcher fails prefixing the failure message with a message. If the message is empty, only the failure message is printed

throw a FailureException if this matcher fails, modifying the failure message with a message.

Returns:: set a new failure message of a matcher

Returns:: a test function corresponding to this matcher

only apply this matcher if the condition is false

Returns:: update the failure message of a matcher

only apply this matcher if the condition is true