org.specs2.matcher

OptionLikeMatcher

class OptionLikeMatcher[F[_], T, U] extends Matcher[F[T]]

Linear Supertypes
Matcher[F[T]], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OptionLikeMatcher
  2. Matcher
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionLikeMatcher(typeName: String, toOption: (F[T]) ⇒ Option[U])

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. def ^^[S](f: (S) ⇒ Expectable[F[T]], dummy: Int = 0): Matcher[S]

    Adapt a matcher to another.

    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

    Definition Classes
    Matcher
  5. def ^^[S](f: (S) ⇒ F[T]): Matcher[S]

    Adapt a matcher to another.

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

    Definition Classes
    Matcher
  6. def and[S <: F[T]](m: ⇒ Matcher[S]): Matcher[S]

    the logical and between 2 matchers

    the logical and between 2 matchers

    Definition Classes
    Matcher
    See also

    MatchResult.and

  7. def apply[S <: F[T]](value: Expectable[S]): MatchResult[S]

    apply this matcher to an Expectable

    apply this matcher to an Expectable

    returns

    a MatchResult describing the outcome of the match

    Definition Classes
    OptionLikeMatcherMatcher
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def eventually(retries: Int, sleep: Duration): Matcher[F[T]]

    returns

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

    Definition Classes
    Matcher
  13. def eventually: Matcher[F[T]]

    returns

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

    Definition Classes
    Matcher
  14. def failure[S <: F[T]](message: ⇒ String, value: Expectable[S]): MatchResult[S]

    This method can be used to create a failed match result

    This method can be used to create a failed match result

    Attributes
    protected
    Definition Classes
    Matcher
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. def iff(b: Boolean): Matcher[F[T]]

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

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

    Definition Classes
    Matcher
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. def lazily: Matcher[() ⇒ F[T]]

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

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

    Definition Classes
    Matcher
  21. def like[R](f: PartialFunction[U, R])(implicit arg0: AsResult[R]): OptionLikeCheckedMatcher[F, T, U]

  22. def mute: Matcher[F[T]]

    returns

    a Matcher with no messages

    Definition Classes
    Matcher
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. def not: Matcher[F[T]]

    negate a Matcher

    negate a Matcher

    Definition Classes
    Matcher
    See also

    MatchResult.not

  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def or[S <: F[T]](m: ⇒ Matcher[S]): Matcher[S]

    the logical or between 2 matchers

    the logical or between 2 matchers

    Definition Classes
    Matcher
    See also

    MatchResult.or

  28. def orPending(message: (String) ⇒ String): Matcher[F[T]]

    returns

    a Pending MatchResult if this matcher fails, modifying the failure message with a pending message.

    Definition Classes
    Matcher
  29. def orPending(m: String): Matcher[F[T]]

    returns

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

    Definition Classes
    Matcher
  30. def orPending: Matcher[F[T]]

    returns

    a Pending MatchResult if this matcher fails

    Definition Classes
    Matcher
  31. def orSkip(message: (String) ⇒ String): Matcher[F[T]]

    returns

    a Skip MatchResult if this matcher fails, modifying the failure message with a skip message.

    Definition Classes
    Matcher
  32. def orSkip(m: String): Matcher[F[T]]

    returns

    a Skip MatchResult if this matcher fails, prefixing the failure message with a skip message. If the skip message is empty, only the failure message is printed

    Definition Classes
    Matcher
  33. def orSkip: Matcher[F[T]]

    returns

    a Skip MatchResult if this matcher fails

    Definition Classes
    Matcher
  34. def result[S <: F[T]](other: MatchResultMessages.MatchResultMessage, value: Expectable[S]): MatchResult[S]

    returns

    a MatchResult using the messages embedded in a MatchResultMessage (i.e. an accumulation of messages from other matches)

    Attributes
    protected
    Definition Classes
    Matcher
  35. def result[S <: F[T]](other: Result, value: Expectable[S]): MatchResult[S]

    returns

    a Match Result from another result

    Attributes
    protected
    Definition Classes
    Matcher
  36. def result[S <: F[T]](other: MatchResult[_], value: Expectable[S]): MatchResult[S]

    returns

    a MatchResult copied on another one, but with a different expectable

    Attributes
    protected
    Definition Classes
    Matcher
  37. def result[S <: F[T]](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S], expected: String, actual: String): MatchResult[S]

    This method can be used to evaluate a boolean condition and return an appropriate MatchResult

    This method can be used to evaluate a boolean condition and return an appropriate MatchResult

    returns

    a MatchResult with an okMessage, a koMessage, the expectable value and the expected/actual values as string to display a failure comparison if necessary

    Attributes
    protected
    Definition Classes
    Matcher
  38. def result[S <: F[T]](triplet: ⇒ (Boolean, String, String), value: Expectable[S]): MatchResult[S]

    This method uses a triplet instead of separated arguments

    This method uses a triplet instead of separated arguments

    returns

    a MatchResult with an okMessage, a koMessage and the expectable value

    Attributes
    protected
    Definition Classes
    Matcher
  39. def result[S <: F[T]](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S]): MatchResult[S]

    This method can be used to evaluate a boolean condition and return an appropriate MatchResult

    This method can be used to evaluate a boolean condition and return an appropriate MatchResult

    returns

    a MatchResult with an okMessage, a koMessage and the expectable value

    Attributes
    protected
    Definition Classes
    Matcher
  40. def setMessage(message: String): Matcher[F[T]]

    returns

    set a new failure message of a matcher

    Definition Classes
    Matcher
  41. def success[S <: F[T]](message: ⇒ String, value: Expectable[S]): MatchResult[S]

    This method can be used to create a successful match result

    This method can be used to create a successful match result

    Attributes
    protected
    Definition Classes
    Matcher
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  43. def test: (F[T]) ⇒ Boolean

    returns

    a test function corresponding to this matcher

    Definition Classes
    Matcher
  44. def toString(): String

    Definition Classes
    AnyRef → Any
  45. def unless(b: Boolean, m: String = ""): Matcher[F[T]]

    only apply this matcher if the condition is false

    only apply this matcher if the condition is false

    Definition Classes
    Matcher
  46. def updateMessage(f: (String) ⇒ String): Matcher[F[T]]

    returns

    update the failure message of a matcher

    Definition Classes
    Matcher
  47. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. def when(b: Boolean, m: String = ""): Matcher[F[T]]

    only apply this matcher if the condition is true

    only apply this matcher if the condition is true

    Definition Classes
    Matcher
  51. def which[R](f: (U) ⇒ R)(implicit arg0: AsResult[R]): OptionLikeCheckedMatcher[F, T, U]

Inherited from Matcher[F[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped