Packages

o

scala.xml

Utility

object Utility extends TokenTests

The Utility object provides utility functions for processing instances of bound and not bound XML classes, as well as escaping text nodes.

Linear Supertypes
TokenTests, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Utility
  2. TokenTests
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final val SU: Char('\u001A')
  2. def appendEscapedQuoted(s: String, sb: StringBuilder): StringBuilder

    Appends "s" and escapes and " i s with \"

  3. def appendQuoted(s: String, sb: StringBuilder): collection.mutable.StringBuilder

    Appends "s" if string s does not contain ", 's' otherwise.

  4. def appendQuoted(s: String): String
  5. def checkAttributeValue(value: String): String

    Returns null if the value is a correct attribute value, error message if it isn't.

  6. def checkPubID(s: String): Boolean
    Definition Classes
    TokenTests
  7. def checkSysID(s: String): Boolean
    Definition Classes
    TokenTests
  8. def collectNamespaces(n: Node, set: Set[String]): Unit

    Adds all namespaces in node to set.

  9. def collectNamespaces(nodes: Seq[Node]): Set[String]

    Returns a set of all namespaces used in a sequence of nodes and all their descendants, including the empty namespaces.

  10. final def escape(text: String, s: StringBuilder): StringBuilder

    Appends escaped string to s.

  11. final def escape(text: String): String

    Escapes the characters < > & and " from string.

  12. def getName(s: String, index: Int): String
  13. def hashCode(pre: String, label: String, attribHashCode: Int, scpeHash: Int, children: Seq[Node]): Int

    Returns a hashcode for the given constituents of a node

  14. implicit def implicitSbToString(sb: StringBuilder): String
  15. def isAlpha(c: Char): Boolean

    These are 99% sure to be redundant but refactoring on the safe side.

    These are 99% sure to be redundant but refactoring on the safe side.

    Definition Classes
    TokenTests
  16. def isAlphaDigit(c: Char): Boolean
    Definition Classes
    TokenTests
  17. def isName(s: String): Boolean 

    Name ::= ( Letter | '_' ) (NameChar)*

    See [5] of XML 1.0 specification.

    Definition Classes
    TokenTests
  18. def isNameChar(ch: Char): Boolean 

    NameChar ::= Letter | Digit | '.' | '-' | '_' | ':'
           | CombiningChar | Extender

    See [4] and Appendix B of XML 1.0 specification.

    Definition Classes
    TokenTests
  19. def isNameStart(ch: Char): Boolean 

    NameStart ::= ( Letter | '_' )

    where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }.

    We do not allow a name to start with :. See [3] and Appendix B of XML 1.0 specification

    Definition Classes
    TokenTests
  20. def isPubIDChar(ch: Char): Boolean
    Definition Classes
    TokenTests
  21. final def isSpace(cs: Seq[Char]): Boolean 

    (#x20 | #x9 | #xD | #xA)+
    Definition Classes
    TokenTests
  22. final def isSpace(ch: Char): Boolean 

    (#x20 | #x9 | #xD | #xA)
    Definition Classes
    TokenTests
  23. def isValidIANAEncoding(ianaEncoding: Seq[Char]): Boolean

    Returns true if the encoding name is a valid IANA encoding.

    Returns true if the encoding name is a valid IANA encoding. This method does not verify that there is a decoder available for this encoding, only that the characters are valid for an IANA encoding name.

    ianaEncoding

    The IANA encoding name.

    Definition Classes
    TokenTests
  24. def parseAttributeValue(value: String): Seq[Node]
  25. def parseCharRef(ch: () ⇒ Char, nextch: () ⇒ Unit, reportSyntaxError: (String) ⇒ Unit, reportTruncatedError: (String) ⇒ Unit): String 

    CharRef ::= "&#" '0'..'9' {'0'..'9'} ";"
          | "&#x" '0'..'9'|'A'..'F'|'a'..'f' { hexdigit } ";"

    See [66]

  26. final def prefix(name: String): Option[String]

    Returns prefix of qualified name if any.

  27. def sequenceToXML(children: Seq[Node], pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: MinimizeMode.Value = MinimizeMode.Default): Unit
  28. def serialize(x: Node, pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: MinimizeMode.Value = MinimizeMode.Default): StringBuilder

    Serialize an XML Node to a StringBuilder.

    Serialize an XML Node to a StringBuilder.

    This is essentially a minor rework of toXML that can't have the same name due to an unfortunate combination of named/default arguments and overloading.

    To do

    use a Writer instead

  29. def sort(n: Node): Node

    Return the node with its attribute list sorted alphabetically (prefixes are ignored)

  30. def sort(md: MetaData): MetaData

    returns a sorted attribute list

  31. def trim(x: Node): Node

    Trims an element - call this method, when you know that it is an element (and not a text node) so you know that it will not be trimmed away.

    Trims an element - call this method, when you know that it is an element (and not a text node) so you know that it will not be trimmed away. With this assumption, the function can return a Node, rather than a Seq[Node]. If you don't know, call trimProper and account for the fact that you may get back an empty sequence of nodes.

    Precondition: node is not a text node (it might be trimmed)

  32. def trimProper(x: Node): Seq[Node]

    trim a child of an element.

    trim a child of an element. Attribute values and Atom nodes that are not Text nodes are unaffected.

  33. final def unescape(ref: String, s: StringBuilder): StringBuilder

    Appends unescaped string to s, amp becomes &, lt becomes < etc..

    Appends unescaped string to s, amp becomes &, lt becomes < etc..

    returns

    null if ref was not a predefined entity.

  34. object Escapes

Deprecated Value Members

  1. def toXML(x: Node, pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: Boolean = false): StringBuilder

    Serialize the provided Node to the provided StringBuilder.

    Serialize the provided Node to the provided StringBuilder.

    Note that calling this source-compatible method will result in the same old, arguably almost universally unwanted, behaviour.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Please use serialize instead and specify a minimizeTags parameter