Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package xml
    Definition Classes
    scala
  • package pull

    Classes needed to view an XML document as a series of events.

    Classes needed to view an XML document as a series of events. The document is parsed by an scala.xml.pull.XMLEventReader instance. You can treat it as an scala.collection.Iterator to retrieve the events, which are all subclasses of scala.xml.pull.XMLEvent.

    scala> val source = Source.fromString("""1.0" encoding="UTF-8" standalone="yes"?>
customvalue"?>
BAR">
]>Hello&bar;>""")

source: scala.io.Source = non-empty iterator

scala> val reader = new XMLEventReader(source)
reader: scala.xml.pull.XMLEventReader = non-empty iterator

scala> reader.foreach{ println(_) }
EvProcInstr(instruction,custom value="customvalue")
EvText(
)
EvElemStart(null,foo,,)
EvText(Hello)
EvComment( this is a comment )
EvElemStart(null,bar,,)
EvText(BAR)
EvElemEnd(null,bar)
EvElemStart(null,bar,,)
EvEntityRef(gt)
EvElemEnd(null,bar)
EvElemEnd(null,foo)
EvText(

)
    Definition Classes
    xml
  • EvComment
  • EvElemEnd
  • EvElemStart
  • EvEntityRef
  • EvProcInstr
  • EvText
  • ProducerConsumerIterator
  • XMLEvent
  • XMLEventReader
c

scala.xml.pull

XMLEventReader

class XMLEventReader extends AbstractIterator[XMLEvent] with ProducerConsumerIterator[XMLEvent]

Main entry point into creating an event-based XML parser. Treating this as a scala.collection.Iterator will provide access to the generated events.

Linear Supertypes
ProducerConsumerIterator[XMLEvent], AbstractIterator[XMLEvent], collection.Iterator[XMLEvent], collection.TraversableOnce[XMLEvent], GenTraversableOnce[XMLEvent], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XMLEventReader
  2. ProducerConsumerIterator
  3. AbstractIterator
  4. Iterator
  5. TraversableOnce
  6. GenTraversableOnce
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XMLEventReader(src: Source)

    src

    A scala.io.Source for XML data to parse

Type Members

  1. class GroupedIterator[B >: A] extends AbstractIterator[collection.Seq[B]] with collection.Iterator[collection.Seq[B]]
    Definition Classes
    Iterator

Value Members

  1. def ++[B >: XMLEvent](that: ⇒ GenTraversableOnce[B]): collection.Iterator[B]
    Definition Classes
    Iterator
  2. def /:[B](z: B)(op: (B, XMLEvent) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  3. def :\[B](z: B)(op: (XMLEvent, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  4. val EndOfStream: POISON.type
    Definition Classes
    XMLEventReader → ProducerConsumerIterator
  5. val MaxQueueSize: Int
    Definition Classes
    XMLEventReader → ProducerConsumerIterator
  6. def addString(b: StringBuilder): StringBuilder
    Definition Classes
    TraversableOnce
  7. def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    TraversableOnce
  8. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    TraversableOnce
  9. def aggregate[B](z: ⇒ B)(seqop: (B, XMLEvent) ⇒ B, combop: (B, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  10. def available(): Boolean
    Definition Classes
    ProducerConsumerIterator
  11. def buffered: collection.BufferedIterator[XMLEvent]
    Definition Classes
    Iterator
  12. def collect[B](pf: PartialFunction[XMLEvent, B]): collection.Iterator[B]
    Definition Classes
    Iterator
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) collect has changed. The previous behavior can be reproduced with toSeq.

  13. def collectFirst[B](pf: PartialFunction[XMLEvent, B]): Option[B]
    Definition Classes
    TraversableOnce
  14. def contains(elem: Any): Boolean
    Definition Classes
    Iterator
  15. def copyToArray[B >: XMLEvent](xs: Array[B], start: Int, len: Int): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  16. def copyToArray[B >: XMLEvent](xs: Array[B]): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  17. def copyToArray[B >: XMLEvent](xs: Array[B], start: Int): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  18. def copyToBuffer[B >: XMLEvent](dest: Buffer[B]): Unit
    Definition Classes
    TraversableOnce
  19. def corresponds[B](that: GenTraversableOnce[B])(p: (XMLEvent, B) ⇒ Boolean): Boolean
    Definition Classes
    Iterator
  20. def count(p: (XMLEvent) ⇒ Boolean): Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  21. def drop(n: Int): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  22. def dropWhile(p: (XMLEvent) ⇒ Boolean): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  23. def duplicate: (collection.Iterator[XMLEvent], collection.Iterator[XMLEvent])
    Definition Classes
    Iterator
  24. def exists(p: (XMLEvent) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  25. def filter(p: (XMLEvent) ⇒ Boolean): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  26. def filterNot(p: (XMLEvent) ⇒ Boolean): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  27. def find(p: (XMLEvent) ⇒ Boolean): Option[XMLEvent]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  28. def flatMap[B](f: (XMLEvent) ⇒ GenTraversableOnce[B]): collection.Iterator[B]
    Definition Classes
    Iterator
  29. def fold[A1 >: XMLEvent](z: A1)(op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  30. def foldLeft[B](z: B)(op: (B, XMLEvent) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  31. def foldRight[B](z: B)(op: (XMLEvent, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  32. def forall(p: (XMLEvent) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  33. def foreach[U](f: (XMLEvent) ⇒ U): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  34. def grouped[B >: XMLEvent](size: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  35. def hasDefiniteSize: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  36. def hasNext: Boolean
    Definition Classes
    ProducerConsumerIterator → Iterator
  37. def indexOf[B >: XMLEvent](elem: B, from: Int): Int
    Definition Classes
    Iterator
  38. def indexOf[B >: XMLEvent](elem: B): Int
    Definition Classes
    Iterator
  39. def indexWhere(p: (XMLEvent) ⇒ Boolean, from: Int): Int
    Definition Classes
    Iterator
  40. def indexWhere(p: (XMLEvent) ⇒ Boolean): Int
    Definition Classes
    Iterator
  41. def interruptibly[A](body: ⇒ A): Option[A]
    Definition Classes
    ProducerConsumerIterator
  42. def isEmpty: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  43. def isTraversableAgain: Boolean
    Definition Classes
    Iterator → GenTraversableOnce
  44. def length: Int
    Definition Classes
    Iterator
  45. def map[B](f: (XMLEvent) ⇒ B): collection.Iterator[B]
    Definition Classes
    Iterator
  46. def max[B >: XMLEvent](implicit cmp: Ordering[B]): XMLEvent
    Definition Classes
    TraversableOnce → GenTraversableOnce
  47. def maxBy[B](f: (XMLEvent) ⇒ B)(implicit cmp: Ordering[B]): XMLEvent
    Definition Classes
    TraversableOnce → GenTraversableOnce
  48. def min[B >: XMLEvent](implicit cmp: Ordering[B]): XMLEvent
    Definition Classes
    TraversableOnce → GenTraversableOnce
  49. def minBy[B](f: (XMLEvent) ⇒ B)(implicit cmp: Ordering[B]): XMLEvent
    Definition Classes
    TraversableOnce → GenTraversableOnce
  50. def mkString: String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  51. def mkString(sep: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  52. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  53. def next(): XMLEvent
    Definition Classes
    ProducerConsumerIterator → Iterator
  54. def nonEmpty: Boolean
    Definition Classes
    TraversableOnce → GenTraversableOnce
  55. def padTo[A1 >: XMLEvent](len: Int, elem: A1): collection.Iterator[A1]
    Definition Classes
    Iterator
  56. def partition(p: (XMLEvent) ⇒ Boolean): (collection.Iterator[XMLEvent], collection.Iterator[XMLEvent])
    Definition Classes
    Iterator
  57. def patch[B >: XMLEvent](from: Int, patchElems: collection.Iterator[B], replaced: Int): collection.Iterator[B]
    Definition Classes
    Iterator
  58. val preserveWS: Boolean
  59. def produce(x: XMLEvent): Unit
    Definition Classes
    ProducerConsumerIterator
  60. def product[B >: XMLEvent](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  61. def reduce[A1 >: XMLEvent](op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  62. def reduceLeft[B >: XMLEvent](op: (B, XMLEvent) ⇒ B): B
    Definition Classes
    TraversableOnce
  63. def reduceLeftOption[B >: XMLEvent](op: (B, XMLEvent) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  64. def reduceOption[A1 >: XMLEvent](op: (A1, A1) ⇒ A1): Option[A1]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  65. def reduceRight[B >: XMLEvent](op: (XMLEvent, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  66. def reduceRightOption[B >: XMLEvent](op: (XMLEvent, B) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  67. def sameElements(that: collection.Iterator[_]): Boolean
    Definition Classes
    Iterator
  68. def scanLeft[B](z: B)(op: (B, XMLEvent) ⇒ B): collection.Iterator[B]
    Definition Classes
    Iterator
  69. def scanRight[B](z: B)(op: (XMLEvent, B) ⇒ B): collection.Iterator[B]
    Definition Classes
    Iterator
  70. def seq: collection.Iterator[XMLEvent]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  71. def size: Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  72. def slice(from: Int, until: Int): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  73. def sliding[B >: XMLEvent](size: Int, step: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  74. def span(p: (XMLEvent) ⇒ Boolean): (collection.Iterator[XMLEvent], collection.Iterator[XMLEvent])
    Definition Classes
    Iterator
  75. def stop(): Unit
  76. def sum[B >: XMLEvent](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  77. def take(n: Int): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  78. def takeWhile(p: (XMLEvent) ⇒ Boolean): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  79. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, XMLEvent, Col[XMLEvent]]): Col[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  80. def toArray[B >: XMLEvent](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  81. def toBuffer[B >: XMLEvent]: Buffer[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  82. def toIndexedSeq: collection.immutable.IndexedSeq[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  83. def toIterable: collection.Iterable[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  84. def toIterator: collection.Iterator[XMLEvent]
    Definition Classes
    Iterator → GenTraversableOnce
  85. def toList: List[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  86. def toMap[T, U](implicit ev: <:<[XMLEvent, (T, U)]): Map[T, U]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  87. def toSeq: collection.Seq[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  88. def toSet[B >: XMLEvent]: Set[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  89. def toStream: collection.immutable.Stream[XMLEvent]
    Definition Classes
    Iterator → GenTraversableOnce
  90. def toString(): String
    Definition Classes
    Iterator → AnyRef → Any
  91. def toTraversable: collection.Traversable[XMLEvent]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  92. def toVector: Vector[XMLEvent]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  93. def withFilter(p: (XMLEvent) ⇒ Boolean): collection.Iterator[XMLEvent]
    Definition Classes
    Iterator
  94. def zip[B](that: collection.Iterator[B]): collection.Iterator[(XMLEvent, B)]
    Definition Classes
    Iterator
  95. def zipAll[B, A1 >: XMLEvent, B1 >: B](that: collection.Iterator[B], thisElem: A1, thatElem: B1): collection.Iterator[(A1, B1)]
    Definition Classes
    Iterator
  96. def zipWithIndex: collection.Iterator[(XMLEvent, Int)]
    Definition Classes
    Iterator