scala.xml

Document

class Document extends NodeSeq with XMLEvent

A document information item (according to InfoSet spec). The comments are copied from the Infoset spec, only augmented with some information on the Scala types for definitions that might have no value. also plays the role of an XMLEvent for pull parsing

Inherits

  1. XMLEvent
  2. NodeSeq
  3. Seq
  4. Seq
  5. SeqLike
  6. PartialFunction
  7. Function1
  8. Iterable
  9. Iterable
  10. IterableLike
  11. Equals
  12. Traversable
  13. Immutable
  14. Traversable
  15. GenericTraversableTemplate
  16. TraversableLike
  17. HasNewBuilder
  18. AnyRef
  19. Any

Type Members

  1. class WithFilter extends AnyRef

    A class supporting filtered operations

Value Members

  1. def ++[B >: Node, That](that: Iterator[B])(bf: CanBuildFrom[NodeSeq, B, That]): That

    Concatenates this sequence with the elements of an iterator

  2. def ++[B >: Node, That](that: Traversable[B])(bf: CanBuildFrom[NodeSeq, B, That]): That

    Concatenates this sequence with the elements of a traversable collection

  3. def +:[B >: Node, That](elem: B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Prepends an element to this sequence

  4. def /:[B](z: B)(op: (B, Node) ⇒ B): B

    Applies a binary operator to a start value and all elements of this sequence, going left to right

  5. def :+[B >: Node, That](elem: B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Appends an element to this sequence

  6. def :\[B](z: B)(op: (Node, B) ⇒ B): B

    Applies a binary operator to all elements of this sequence and a start value, going right to left

  7. def \(that: String): NodeSeq

    Projection function

  8. def \\(that: String): NodeSeq

    projection function

  9. def addString(b: StringBuilder): StringBuilder

    Appends all elements of this sequence to a string builder

  10. def addString(b: StringBuilder, sep: String): StringBuilder

    Appends all elements of this sequence to a string builder using a separator string

  11. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Appends all elements of this sequence to a string builder using start, end, and separator strings

  12. var allDeclarationsProcessed: Boolean

    9

  13. def andThen[C](k: (Node) ⇒ C): PartialFunction[Int, C]

    Composes this partial function with a transformation function that gets applied to results of this partial function

  14. def apply(f: (Node) ⇒ Boolean): NodeSeq

  15. def apply(i: Int): Node

    Selects an element by its index in the sequence

  16. var baseURI: String

    The base URI of the document entity

  17. def canEqual(that: Any): Boolean

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind

  18. var children: Seq[Node]

    An ordered list of child information items, in document order

  19. def companion: GenericCompanion[Seq[A][A]]

    The factory companion object that builds instances of class Seq

  20. def compose[A](g: (A) ⇒ Int): (A) ⇒ Node

    (f compose g)(x) == f(g(x))

  21. def contains(elem: Any): Boolean

    Tests whether this sequence contains a given value as an element

  22. def containsSlice[B](that: Seq[B]): Boolean

    Tests whether this sequence contains a given sequence as a slice

  23. def copyToArray[B >: Node](xs: Array[B], start: Int, len: Int): Unit

    Copies elements of this sequence to an array

  24. def copyToArray[B >: Node](xs: Array[B]): Unit

    Copies elements of this sequence to an array

  25. def copyToArray[B >: Node](xs: Array[B], start: Int): Unit

    Copies elements of this sequence to an array

  26. def copyToBuffer[B >: Node](dest: Buffer[B]): Unit

    Copies all elements of this sequence to a buffer

  27. def corresponds[B](that: Seq[B])(p: (Node, B) ⇒ Boolean): Boolean

    Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate

  28. def count(p: (Node) ⇒ Boolean): Int

    Counts the number of elements in the sequence which satisfy a predicate

  29. def diff[B >: Node, That](that: Seq[B]): NodeSeq

    Computes the multiset difference between this sequence and another sequence

  30. var docElem: Node

    The element information item corresponding to the document element

  31. def drop(n: Int): NodeSeq

    Selects all elements except first n ones

  32. def dropRight(n: Int): NodeSeq

    Selects all elements except first n ones

  33. def dropWhile(p: (Node) ⇒ Boolean): NodeSeq

    Drops longest prefix of elements that satisfy a predicate

  34. var dtd: DTD

    The dtd that comes with the document, if any

  35. def elements: Iterator[Node]

  36. var encoding: Option[String]

    The name of the character encoding scheme in which the document entity is expressed

  37. def endsWith[B](that: Seq[B]): Boolean

    Tests whether this sequence ends with the given sequence

  38. def equals(x: Any): Boolean

    structural equality (XXX - this shatters any hope of hashCode equality) @return true if the receiver object is equivalent to the argument; false otherwise

  39. def equalsWith[B](that: Seq[B])(f: (Node, B) ⇒ Boolean): Boolean

    Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate

  40. def exists(p: (Node) ⇒ Boolean): Boolean

    Tests whether a predicate holds for some of the elements of this sequence

  41. def filter(p: (Node) ⇒ Boolean): NodeSeq

    Selects all elements of this sequence which satisfy a predicate

  42. def filterNot(p: (Node) ⇒ Boolean): NodeSeq

    Selects all elements of this sequence which do not satisfy a predicate

  43. def find(p: (Node) ⇒ Boolean): Option[Node]

    Finds the first element of the sequence satisfying a predicate, if any

  44. def findIndexOf(p: (Node) ⇒ Boolean): Int

    Returns index of the first element satisying a predicate, or -1

  45. def findLastIndexOf(p: (Node) ⇒ Boolean): Int

    Returns index of the last element satisying a predicate, or -1

  46. def first: Node

  47. def firstOption: Option[Node]

    None if iterable is empty

  48. def flatMap[B, That](f: (Node) ⇒ Traversable[B])(bf: CanBuildFrom[NodeSeq, B, That]): That

    Builds a new collection by applying a function to all elements of this sequence and concatenating the results

  49. def flatten[B](asTraversable: (Node) ⇒ Traversable[B]): Seq[B]

    Converts this sequence of traversable collections into a sequence in which all element collections are concatenated

  50. def foldLeft[B](z: B)(op: (B, Node) ⇒ B): B

    Applies a binary operator to a start value and all elements of this sequence, going left to right

  51. def foldRight[B](z: B)(op: (Node, B) ⇒ B): B

    Applies a binary operator to all elements of this sequence and a start value, going right to left

  52. def forall(p: (Node) ⇒ Boolean): Boolean

    Tests whether a predicate holds for all elements of this sequence

  53. def foreach[U](f: (Node) ⇒ U): Unit

    Applies a function f to all elements of this sequence

  54. def genericBuilder[B]: Builder[B, Seq[B]]

    The generic builder that builds instances of Seq at arbitrary element types

  55. def groupBy[K](f: (Node) ⇒ K): Map[K, NodeSeq]

    Partitions this sequence into a map of sequences according to some discriminator function

  56. def hasDefiniteSize: Boolean

    Tests whether this sequence is known to have a finite size

  57. def hashCode(): Int

    Hashcodes for Seq produce a value from the hashcodes of all the elements of the sequence

  58. def head: Node

    Selects the first element of this sequence

  59. def headOption: Option[Node]

    Optionally selects the first element

  60. def indexOf[B >: Node](elem: B, from: Int): Int

    Finds index of first occurrence of some value in this sequence after or at some start index

  61. def indexOf[B >: Node](elem: B): Int

    Finds index of first occurrence of some value in this sequence

  62. def indexOfSlice[B >: Node](that: Seq[B], from: Int): Int

    Finds first index after or at a start index where this sequence contains a given sequence as a slice

  63. def indexOfSlice[B >: Node](that: Seq[B]): Int

    Finds first index where this sequence contains a given sequence as a slice

  64. def indexWhere(p: (Node) ⇒ Boolean, from: Int): Int

    Finds index of the first element satisfying some predicate after or at some start index

  65. def indexWhere(p: (Node) ⇒ Boolean): Int

    Finds index of first element satisfying some predicate

  66. def indices: Range

    Produces the range of all indices of this sequence

  67. def init: NodeSeq

    Selects all elements except the last

  68. def intersect[B >: Node, That](that: Seq[B]): NodeSeq

    Computes the multiset intersection between this sequence and another sequence

  69. def isDefinedAt(idx: Int): Boolean

    Tests whether this sequence contains given index

  70. def isEmpty: Boolean

    Tests whether this sequence is empty

  71. def iterator: Iterator[Node]

    Creates a new iterator over all elements contained in this iterable object

  72. def last: Node

    Selects the last element

  73. def lastIndexOf[B >: Node](elem: B, end: Int): Int

    Finds index of last occurrence of some value in this sequence before or at a given end index

  74. def lastIndexOf[B >: Node](elem: B): Int

    Finds index of last occurrence of some value in this sequence

  75. def lastIndexOfSlice[B >: Node](that: Seq[B], end: Int): Int

    Finds last index before or at a given end index where this sequence contains a given sequence as a slice

  76. def lastIndexOfSlice[B >: Node](that: Seq[B]): Int

    Finds last index where this sequence contains a given sequence as a slice

  77. def lastIndexWhere(p: (Node) ⇒ Boolean, end: Int): Int

    Finds index of last element satisfying some predicate before or at given end index

  78. def lastIndexWhere(p: (Node) ⇒ Boolean): Int

    Finds index of last element satisfying some predicate

  79. def lastOption: Option[Node]

    Optionally selects the last element

  80. def length: Int

    The length of the sequence

  81. def lengthCompare(len: Int): Int

    Compares the length of this sequence to a test value

  82. def lift: (Int) ⇒ Option[Node]

    Turns this partial function into an plain function returning an Option result

  83. def map[B, That](f: (Node) ⇒ B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Builds a new collection by applying a function to all elements of this sequence

  84. def max[B >: Node](cmp: Ordering[B]): Node

    Finds the largest element

  85. def min[B >: Node](cmp: Ordering[B]): Node

    Finds the smallest element

  86. def mkString: String

    Displays all elements of this sequence in a string

  87. def mkString(sep: String): String

    Displays all elements of this sequence in a string using a separator string

  88. def mkString(start: String, sep: String, end: String): String

    Displays all elements of this sequence in a string using start, end, and separator strings

  89. def nonEmpty: Boolean

    Tests whether the sequence is not empty

  90. def notations: Seq[NotationDecl]

    An unordered set of notation information items, one for each notation declared in the DTD

  91. def orElse[A1 <: Int, B1 >: Node](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

    Composes this partial function with a fallback partial function which gets applied where this partial function is not defined

  92. def padTo[B >: Node, That](len: Int, elem: B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Appends an element value to this sequence until a given target length is reached

  93. def partialMap[B, That](pf: PartialFunction[Node, B])(bf: CanBuildFrom[NodeSeq, B, That]): That

    Builds a new collection by applying a partial function to all elements of this sequence on which the function is defined

  94. def partition(p: (Node) ⇒ Boolean): (NodeSeq, NodeSeq)

    Partitions this sequence in two sequences according to a predicate

  95. def patch[B >: Node, That](from: Int, patch: Seq[B], replaced: Int)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Produces a new sequence where a slice of elements in this sequence is replaced by another sequence

  96. def prefixLength(p: (Node) ⇒ Boolean): Int

    Returns the length of the longest prefix whose elements all satisfy some preficate

  97. def product[B >: Node](num: Numeric[B]): B

    Multiplies up the elements of this collection

  98. def projection: SeqView[Node, NodeSeq]

    returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection

  99. def reduceLeft[B >: Node](op: (B, Node) ⇒ B): B

    Applies a binary operator to all elements of this sequence, going left to right

  100. def reduceLeftOption[B >: Node](op: (B, Node) ⇒ B): Option[B]

    Optionally applies a binary operator to all elements of this sequence, going left to right

  101. def reduceRight[B >: Node](op: (Node, B) ⇒ B): B

    Applies a binary operator to all elements of this sequence, going right to left

  102. def reduceRightOption[B >: Node](op: (Node, B) ⇒ B): Option[B]

    Optionally applies a binary operator to all elements of this sequence, going right to left

  103. def removeDuplicates: NodeSeq

    Builds a new sequence from this sequence without any duplicate elements

  104. def repr: NodeSeq

    The collection of type sequence underlying this TraversableLike object

  105. def reverse: NodeSeq

    Returns new sequence wih elements in reversed order

  106. def reverseIterator: Iterator[Node]

    An iterator yielding elements in reversed order

  107. def reverseMap[B, That](f: (Node) ⇒ B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    Builds a new collection by applying a function to all elements of this sequence and collecting the results in reversed order

  108. def reversedElements: Iterator[Node]

  109. def sameElements[B >: Node](that: Iterable[B]): Boolean

    Checks if the other iterable collection contains the same elements in the same order as this sequence

  110. def segmentLength(p: (Node) ⇒ Boolean, from: Int): Int

    Computes length of longest segment whose elements all satisfy some preficate

  111. def size: Int

    The size of this sequence, equivalent to length

  112. def slice(from: Int, until: Int): NodeSeq

    Selects an interval of elements

  113. def sortBy[B](f: (Node) ⇒ B)(ord: Ordering[B]): NodeSeq

    Sorts this Seq according to the Ordering which results from transforming an implicitly given Ordering with a transformation function

  114. def sortWith[B >: Node](ord: Ordering[B]): NodeSeq

    Sorts this sequence according to an Ordering

  115. def sortWith(lt: (Node, Node) ⇒ Boolean): NodeSeq

    Sorts this sequence according to a comparison function

  116. def span(p: (Node) ⇒ Boolean): (NodeSeq, NodeSeq)

    Spits this sequence into a prefix/suffix pair according to a predicate

  117. def splitAt(n: Int): (NodeSeq, NodeSeq)

    Splits this sequence into two at a given position

  118. var standAlone: Option[Boolean]

    An indication of the standalone status of the document, either true or false

  119. def startsWith[B](that: Seq[B]): Boolean

    Tests whether this sequence starts with the given sequence

  120. def startsWith[B](that: Seq[B], offset: Int): Boolean

    Tests whether this sequence contains the given sequence at a given index

  121. def stringPrefix: String

    Defines the prefix of this object's toString representation

  122. def sum[B >: Node](num: Numeric[B]): B

    Sums up the elements of this collection

  123. def tail: NodeSeq

    Selects all elements except the first

  124. def take(n: Int): NodeSeq

    Selects first n elements

  125. def takeRight(n: Int): NodeSeq

    Selects last n elements

  126. def takeWhile(p: (Node) ⇒ Boolean): NodeSeq

    Takes longest prefix of elements that satisfy a predicate

  127. def text: String

  128. def theSeq: Seq[Node]

  129. def toArray[B >: Node](arg0: ClassManifest[B]): Array[B]

    Converts this sequence to an array

  130. def toIndexedSeq[B >: Node]: IndexedSeq[B]

    Converts this sequence to an indexed sequence

  131. def toIterable: Iterable[Node]

    Converts this sequence to an iterable collection

  132. def toList: List[Node]

    Converts this sequence to a list

  133. def toSeq: Seq[Node]

    Converts this sequence to a sequence

  134. def toSet[B >: Node]: Set[B]

    Converts this sequence to a set

  135. def toStream: Stream[Node]

    Converts this sequence to a stream

  136. def toString(): String

    Converts this sequence to a string

  137. def transpose[B](asTraversable: (Node) ⇒ Traversable[B]): Seq[Seq[B]]

    Transposes this sequence of traversable collections into

  138. def union[B >: Node, That](that: Seq[B])(bf: CanBuildFrom[NodeSeq, B, That]): That

    Produces a new sequence which contains all elements of this sequence and also all elements of a given sequence

  139. def unparsedEntities: Seq[EntityDecl]

    An unordered set of unparsed entity information items, one for each unparsed entity declared in the DTD

  140. def unzip[A1, A2](asPair: (Node) ⇒ (A1, A2)): (Seq[A1], Seq[A2])

    Converts this sequence of pairs into two collections of the first and second halfs of each pair

  141. def updated[B >: Node, That](index: Int, elem: B)(bf: CanBuildFrom[NodeSeq, B, That]): That

    A copy of this sequence with one single replaced element

  142. var version: Option[String]

    A string representing the XML version of the document

  143. def view(from: Int, until: Int): SeqView[Node, NodeSeq]

    Creates a non-strict view of a slice of this sequence

  144. def view: SeqView[Node, NodeSeq]

    Creates a non-strict view of this sequence

  145. def withFilter(p: (Node) ⇒ Boolean): WithFilter

    Creates a non-strict filter of this sequence

  146. def zip[A1 >: Node, B, That](that: Iterable[B])(bf: CanBuildFrom[NodeSeq, (A1, B), That]): That

    Returns a sequence formed from this sequence and another iterable collection by combining corresponding elements in pairs

  147. def zipAll[B, A1 >: Node, That](that: Iterable[B], thisElem: A1, thatElem: B)(bf: CanBuildFrom[NodeSeq, (A1, B), That]): That

    Returns a sequence formed from this sequence and another iterable collection by combining corresponding elements in pairs

  148. def zipWithIndex[A1 >: Node, That](bf: CanBuildFrom[NodeSeq, (A1, Int), That]): That

    Zips this sequence with its indices

Instance constructors

  1. new Document()