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 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. final val SU: Char
  5. def appendEscapedQuoted(s: String, sb: StringBuilder): StringBuilder

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

  6. def appendQuoted(s: String, sb: StringBuilder): StringBuilder

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

  7. def appendQuoted(s: String): String
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def checkAttributeValue(value: String): String

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

  10. def checkPubID(s: String): Boolean
    Definition Classes
    TokenTests
  11. def checkSysID(s: String): Boolean
    Definition Classes
    TokenTests
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def collectNamespaces(n: Node, set: Set[String]): Unit

    Adds all namespaces in node to set.

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

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

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. final def escape(text: String, s: StringBuilder): StringBuilder

    Appends escaped string to s.

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

    Escapes the characters < > & and " from string.

  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getName(s: String, index: Int): String
  22. def hashCode(pre: String, label: String, attribHashCode: Int, scpeHash: Int, children: collection.Seq[Node]): Int

    Returns a hashcode for the given constituents of a node

  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. implicit def implicitSbToString(sb: StringBuilder): String
  25. 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
  26. def isAlphaDigit(c: Char): Boolean
    Definition Classes
    TokenTests
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isName(s: String): Boolean 

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

    See [5] of XML 1.0 specification.

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

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

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

    Definition Classes
    TokenTests
  30. 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 [4] and Appendix B of XML 1.0 specification

    Definition Classes
    TokenTests
  31. def isPubIDChar(ch: Char): Boolean
    Definition Classes
    TokenTests
  32. final def isSpace(cs: collection.Seq[Char]): Boolean 

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

    (#x20 | #x9 | #xD | #xA)
    Definition Classes
    TokenTests
  34. def isValidIANAEncoding(ianaEncoding: collection.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
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def parseAttributeValue(value: String): collection.Seq[Node]
  39. 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]

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

    Returns prefix of qualified name if any.

  41. def sequenceToXML(children: collection.Seq[Node], pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: MinimizeMode.Value = MinimizeMode.Default): Unit
  42. 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

  43. def sort(n: Node): Node

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

  44. def sort(md: MetaData): MetaData

    returns a sorted attribute list

  45. def splitName(name: String): (Option[String], String)
  46. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. 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)

  49. def trimProper(x: Node): collection.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.

  50. 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.

  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  54. 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

Inherited from TokenTests

Inherited from AnyRef

Inherited from Any

Ungrouped