# BetweenMatcher

### Related Doc: package matcher

#### case class BetweenMatcher[T](t1: T, t2: T, includeStart: Boolean = true, includeEnd: Boolean = true)(implicit evidence\$49: (T) ⇒ Ordered[T]) extends Matcher[T] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, Matcher[T], AnyRef, Any
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. BetweenMatcher
2. Serializable
3. Serializable
4. Product
5. Equals
6. Matcher
7. AnyRef
8. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### 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

6. #### def ^^[S](f: (S) ⇒ Expectable[T], dummy: Int = 0): Matcher[S]

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
7. #### def ^^[S](f: (S) ⇒ T): Matcher[S]

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

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

the logical and between 2 matchers

the logical and between 2 matchers

Definition Classes
Matcher

MatchResult.and

9. #### def apply[S <: T](s: 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
BetweenMatcherMatcher
10. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
11. #### def clone(): AnyRef

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

Definition Classes
AnyRef
13. #### def eventually(retries: Int, sleep: Duration): Matcher[T]

returns

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

Definition Classes
Matcher
14. #### def eventually: Matcher[T]

returns

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

Definition Classes
Matcher

18. #### def failure[S <: 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
19. #### def finalize(): Unit

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

Definition Classes
AnyRef → Any
21. #### def iff(b: Boolean): Matcher[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

24. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
25. #### def lazily: Matcher[() ⇒ 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
26. #### def mute: Matcher[T]

returns

a Matcher with no messages

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

Definition Classes
AnyRef
28. #### def not: Matcher[T]

negate a Matcher

negate a Matcher

Definition Classes
Matcher

MatchResult.not

29. #### final def notify(): Unit

Definition Classes
AnyRef
30. #### final def notifyAll(): Unit

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

the logical or between 2 matchers

the logical or between 2 matchers

Definition Classes
Matcher

MatchResult.or

32. #### def orPending(message: (String) ⇒ String): Matcher[T]

returns

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

Definition Classes
Matcher
33. #### def orPending(m: String): Matcher[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
34. #### def orPending: Matcher[T]

returns

a Pending MatchResult if this matcher fails

Definition Classes
Matcher
35. #### def orSkip(message: (String) ⇒ String): Matcher[T]

returns

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

Definition Classes
Matcher
36. #### def orSkip(m: String): Matcher[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
37. #### def orSkip: Matcher[T]

returns

a Skip MatchResult if this matcher fails

Definition Classes
Matcher
38. #### def result[S <: 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
39. #### def result[S <: T](other: Result, value: Expectable[S]): MatchResult[S]

returns

a Match Result from another result

Attributes
protected
Definition Classes
Matcher
40. #### def result[S <: 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
41. #### def result[S <: T](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S], details: Details): MatchResult[S]

returns

a MatchResult with an okMessage, a koMessage, the expectable value and details about the failure if any

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

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
43. #### def result[S <: T](triplet: ⇒ (Boolean, String, String), value: Expectable[S]): MatchResult[S]

returns

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

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

returns

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

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

returns

set a new failure message of a matcher

Definition Classes
Matcher
46. #### def success[S <: 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
47. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef

50. #### def test: (T) ⇒ Boolean

returns

a test function corresponding to this matcher

Definition Classes
Matcher
51. #### def unless(b: Boolean, m: String = ""): Matcher[T]

only apply this matcher if the condition is false

only apply this matcher if the condition is false

Definition Classes
Matcher
52. #### def updateMessage(f: (String) ⇒ String): Matcher[T]

returns

update the failure message of a matcher

Definition Classes
Matcher
53. #### final def wait(): Unit

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

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

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

only apply this matcher if the condition is true

only apply this matcher if the condition is true

Definition Classes
Matcher