org.specs2.matcher

XmlMatcher

Related Doc: package matcher

case class XmlMatcher(functions: Seq[PathFunction]) extends Matcher[Seq[Node]] with Product with Serializable

The XmlMatcher class matches an xml Node, or a list of Nodes against a list of search functions, which can either search for:

XmlMatchers can be "chained" by using the \ or the \\ methods. In that case, the resulting matcher has a new search function which tries to match the result of the preceding function. For example

 must \\("c").\("d")
will be ok. must \\("c").\("d")

Linear Supertypes
Serializable, Serializable, Product, Equals, Matcher[Seq[Node]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. XmlMatcher
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Matcher
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XmlMatcher(functions: Seq[PathFunction])

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 \(label: String, attributeValues: (String, String), attributeValues2: (String, String)*): XmlMatcher

  5. def \(label: String, attributeNames: String*): XmlMatcher

    alias for \ using the node label only

  6. def \(node: Node, attributeValues: (String, String), attributeValues2: (String, String)*): XmlMatcher

  7. def \(node: Node, attributeNames: String*): XmlMatcher

  8. def \>(t: String): XmlMatcher

    alias for textIs

  9. def \>~(t: String): XmlMatcher

    alias for textMatches

  10. def \\(label: String, attributeValues: (String, String), attributeValues2: (String, String)*): XmlMatcher

  11. def \\(label: String, attributeNames: String*): XmlMatcher

    alias for \\ using the node label only

  12. def \\(node: Node, attributeValues: (String, String), attributeValues2: (String, String)*): XmlMatcher

  13. def \\(node: Node, attributeNames: String*): XmlMatcher

  14. def ^^[S](f: (S) ⇒ Expectable[Seq[Node]], 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
  15. def ^^[S](f: (S) ⇒ Seq[Node]): 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
  16. def and[S <: Seq[Node]](m: ⇒ Matcher[S]): Matcher[S]

    the logical and between 2 matchers

    the logical and between 2 matchers

    Definition Classes
    Matcher
    See also

    MatchResult.and

  17. def apply[S <: Seq[Node]](n: Expectable[S]): MatchResult[S]

    checks that the nodes satisfy the functions

    checks that the nodes satisfy the functions

    returns

    a MatchResult describing the outcome of the match

    Definition Classes
    XmlMatcherMatcher
  18. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  19. def checkFunctions(pathFunctions: Seq[PathFunction], nodes: Seq[Node], messages: (Boolean, String, String)): (Boolean, String, String)

    checks that the nodes satisfy the functions

    checks that the nodes satisfy the functions

    returns

    a MatcherResult

  20. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  22. def eventually(retries: Int, sleep: Duration): Matcher[Seq[Node]]

    returns

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

    Definition Classes
    Matcher
  23. def eventually: Matcher[Seq[Node]]

    returns

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

    Definition Classes
    Matcher
  24. def exactly: XmlMatcher

    do an exact match on attributes and attributes values

  25. def failure[S <: Seq[Node]](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
  26. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. val functions: Seq[PathFunction]

  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  29. def iff(b: Boolean): Matcher[Seq[Node]]

    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
  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def lazily: Matcher[() ⇒ Seq[Node]]

    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
  32. def mute: Matcher[Seq[Node]]

    returns

    a Matcher with no messages

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

    Definition Classes
    AnyRef
  34. def not: Matcher[Seq[Node]]

    negate a Matcher

    negate a Matcher

    Definition Classes
    Matcher
    See also

    MatchResult.not

  35. final def notify(): Unit

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

    Definition Classes
    AnyRef
  37. def or[S <: Seq[Node]](m: ⇒ Matcher[S]): Matcher[S]

    the logical or between 2 matchers

    the logical or between 2 matchers

    Definition Classes
    Matcher
    See also

    MatchResult.or

  38. def orPending(message: (String) ⇒ String): Matcher[Seq[Node]]

    returns

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

    Definition Classes
    Matcher
  39. def orPending(m: String): Matcher[Seq[Node]]

    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
  40. def orPending: Matcher[Seq[Node]]

    returns

    a Pending MatchResult if this matcher fails

    Definition Classes
    Matcher
  41. def orSkip(message: (String) ⇒ String): Matcher[Seq[Node]]

    returns

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

    Definition Classes
    Matcher
  42. def orSkip(m: String): Matcher[Seq[Node]]

    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
  43. def orSkip: Matcher[Seq[Node]]

    returns

    a Skip MatchResult if this matcher fails

    Definition Classes
    Matcher
  44. def result[S <: Seq[Node]](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
  45. def result[S <: Seq[Node]](other: Result, value: Expectable[S]): MatchResult[S]

    returns

    a Match Result from another result

    Attributes
    protected
    Definition Classes
    Matcher
  46. def result[S <: Seq[Node]](other: MatchResult[_], value: Expectable[S]): MatchResult[S]

    returns

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

    Attributes
    protected
    Definition Classes
    Matcher
  47. def result[S <: Seq[Node]](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
  48. def result[S <: Seq[Node]](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
  49. def result[S <: Seq[Node]](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
  50. def result[S <: Seq[Node]](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
  51. def setMessage(message: String): Matcher[Seq[Node]]

    returns

    set a new failure message of a matcher

    Definition Classes
    Matcher
  52. def success[S <: Seq[Node]](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
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. def test: (Seq[Node]) ⇒ Boolean

    returns

    a test function corresponding to this matcher

    Definition Classes
    Matcher
  55. def textIs(t: String): XmlMatcher

    specify the value of the node text

  56. def textMatches(regexp: String): XmlMatcher

    specify the value of the node text

  57. def unless(b: Boolean, m: String = ""): Matcher[Seq[Node]]

    only apply this matcher if the condition is false

    only apply this matcher if the condition is false

    Definition Classes
    Matcher
  58. def updateMessage(f: (String) ⇒ String): Matcher[Seq[Node]]

    returns

    update the failure message of a matcher

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. def when(b: Boolean, m: String = ""): Matcher[Seq[Node]]

    only apply this matcher if the condition is true

    only apply this matcher if the condition is true

    Definition Classes
    Matcher

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Matcher[Seq[Node]]

Inherited from AnyRef

Inherited from Any

Ungrouped