xml

Type Members

class Atom[+A] extends SpecialNode with Serializable

The class Atom provides an XML node for text (PCDATA).
The class Atom provides an XML node for text (PCDATA). It is used in both non-bound and bound XML representations.
trait Attribute extends MetaData

The Attribute trait defines the interface shared by both scala.xml.PrefixedAttribute and scala.xml.UnprefixedAttribute.
case class Comment(commentText: String) extends SpecialNode with Product with Serializable

The class Comment implements an XML node for comments.
The class Comment implements an XML node for comments.
commentText
the text contained in this node, may not contain "--"
class Document extends NodeSeq with XMLEvent with Serializable

A document information item (according to InfoSet spec).
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.

Annotations
@SerialVersionUID()
class Elem extends Node with Serializable

An immutable data object representing an XML element.
An immutable data object representing an XML element.
Child elements can be other Elems or any one of the other Node types.
XML attributes are implemented with the scala.xml.MetaData base class.
Optional XML namespace scope is represented by scala.xml.NamespaceBinding.
case class EntityRef(entityName: String) extends SpecialNode with Product with Serializable

The class EntityRef implements an XML node for entity references.
The class EntityRef implements an XML node for entity references.
entityName
the name of the entity reference, for example amp.
type EntityResolver = org.xml.sax.EntityResolver
trait Equality extends Equals
final case class Group(nodes: collection.Seq[Node]) extends Node with Product with Serializable

A hack to group XML nodes in one node for output.
type InputSource = org.xml.sax.InputSource
case class MalformedAttributeException(msg: String) extends RuntimeException with Product with Serializable
abstract class MetaData extends AbstractIterable[MetaData] with Iterable[MetaData] with Equality with Serializable

This class represents an attribute and at the same time a linked list of attributes.
This class represents an attribute and at the same time a linked list of attributes. Every instance of this class is either
- an instance of UnprefixedAttribute key,value or
- an instance of PrefixedAttribute namespace_prefix,key,value or
- Null, the empty attribute list.
Namespace URIs are obtained by using the namespace scope of the element owning this attribute (see getNamespace).
case class NamespaceBinding(prefix: String, uri: String, parent: NamespaceBinding) extends Equality with Product with Serializable

The class NamespaceBinding represents namespace bindings and scopes.
The class NamespaceBinding represents namespace bindings and scopes. The binding for the default namespace is treated as a null prefix. the absent namespace is represented with the null uri. Neither prefix nor uri may be empty, which is not checked.

Annotations
@SerialVersionUID()
abstract class Node extends NodeSeq

An abstract class representing XML with nodes of a labeled tree.
An abstract class representing XML with nodes of a labeled tree. This class contains an implementation of a subset of XPath for navigation.
- scala.xml.Comment — XML comment
- scala.xml.Elem — XML element
- scala.xml.EntityRef — XML entity
- scala.xml.PCData — Character data section (CDATA)
- scala.xml.ProcInstr — Processing instruction (PI)
- scala.xml.Text — Stand-alone parsed character data
class NodeBuffer extends ArrayBuffer[Node] with ScalaVersionSpecificNodeBuffer

This class acts as a Buffer for nodes.
This class acts as a Buffer for nodes. If it is used as a sequence of nodes collection.Seq[Node], it must be ensured that no updates occur after that point, because scala.xml.Node is assumed to be immutable.
Despite this being a sequence, don't use it as key in a hashtable. Calling the hashcode function will result in a runtime error.
abstract class NodeSeq extends AbstractSeq[Node] with collection.immutable.Seq[Node] with ScalaVersionSpecificNodeSeq with Equality with Serializable

This class implements a wrapper around collection.Seq[Node] that adds XPath and comprehension methods.
class PCData extends Atom[String]

This class (which is not used by all XML parsers, but always used by the XHTML one) represents parseable character data, which appeared as CDATA sections in the input and is to be preserved as CDATA section in the output.
class PrefixedAttribute extends MetaData with Attribute

prefixed attributes always have a non-null namespace.
class PrettyPrinter extends AnyRef

Class for pretty printing.
Class for pretty printing. After instantiating, you can use the format() and formatNode() methods to convert XML to a formatted string. The class can be reused to pretty print any number of XML nodes.
case class ProcInstr(target: String, proctext: String) extends SpecialNode with Product with Serializable

an XML node for processing instructions (PI)
an XML node for processing instructions (PI)
target
target name of this PI
proctext
text contained in this node, may not contain "?>"
type SAXException = org.xml.sax.SAXException
type SAXParseException = org.xml.sax.SAXParseException
type SAXParser = javax.xml.parsers.SAXParser
trait ScalaVersionSpecificNodeBuffer extends AnyRef
trait ScalaVersionSpecificNodeSeq extends SeqLike[Node, NodeSeq]
abstract class SpecialNode extends Node with XMLEvent

SpecialNode is a special XML node which represents either text (PCDATA), a comment, a PI, or an entity ref.
SpecialNode is a special XML node which represents either text (PCDATA), a comment, a PI, or an entity ref.
SpecialNodes also play the role of scala.xml.pull.XMLEvents for pull-parsing.
class Text extends Atom[String]

The class Text implements an XML node for text (PCDATA).
The class Text implements an XML node for text (PCDATA). It is used in both non-bound and bound XML representations.
class TextBuffer extends AnyRef

The class TextBuffer is for creating text nodes without surplus whitespace.
The class TextBuffer is for creating text nodes without surplus whitespace. All occurrences of one or more whitespace in strings appended with the append method will be replaced by a single space character, and leading and trailing space will be removed completely.
abstract class TypeSymbol extends AnyRef
class Unparsed extends Atom[String]

An XML node for unparsed content.
An XML node for unparsed content. It will be output verbatim, all bets are off regarding wellformedness etc.
class UnprefixedAttribute extends MetaData with Attribute

Unprefixed attributes have the null namespace, and no prefix field

Value Members

object Attribute extends Serializable

This singleton object contains the apply and unapply methods for convenient construction and deconstruction.
object Elem extends Serializable

This singleton object contains the apply and unapplySeq methods for convenient construction and deconstruction.
This singleton object contains the apply and unapplySeq methods for convenient construction and deconstruction. It is possible to deconstruct any Node instance (that is not a SpecialNode or a Group) using the syntax case Elem(prefix, label, attribs, scope, child @ _*) => ...
object Equality

In an attempt to contain the damage being inflicted on consistency by the ad hoc equals methods spread around xml, the logic is centralized and all the xml classes go through the xml.Equality trait.
In an attempt to contain the damage being inflicted on consistency by the ad hoc equals methods spread around xml, the logic is centralized and all the xml classes go through the xml.Equality trait. There are two forms of xml comparison.
1. def strict_==(other: scala.xml.Equality)
This one tries to honor the little things like symmetry and hashCode contracts. The equals method routes all comparisons through this.
1. xml_==(other: Any)
This one picks up where strict_== leaves off. It might declare any two things equal.
As things stood, the logic not only made a mockery of the collections equals contract, but also laid waste to that of case classes.
Among the obstacles to sanity are/were:
Node extends NodeSeq extends collection.Seq[Node] MetaData extends Iterable[MetaData] The hacky "Group" xml node which throws exceptions with wild abandon, so don't get too close Rampant asymmetry and impossible hashCodes Most classes claiming to be equal to "String" if some specific stringification of it was the same. String was never going to return the favor.
object MetaData extends Serializable
object MinimizeMode extends Enumeration

Governs how empty elements (i.e.
Governs how empty elements (i.e. those without child elements) should be serialized.
object Node extends Serializable

This singleton object contains the unapplySeq method for convenient deconstruction.
object NodeSeq extends Serializable

This object ...
object Null extends MetaData with Product with Serializable

Essentially, every method in here is a dummy, returning Zero[T].
Essentially, every method in here is a dummy, returning Zero[T]. It provides a backstop for the unusual collection defined by MetaData, sort of a linked list of tails.
object PCData extends Serializable

This singleton object contains the applyand unapply methods for convenient construction and deconstruction.
object PrefixedAttribute extends Serializable
object Properties extends PropertiesTrait
object QNode

This object provides an extractor method to match a qualified node with its namespace URI
object ScalaVersionSpecific
object Source
object Text extends Serializable

This singleton object contains the applyand unapply methods for convenient construction and deconstruction.
object TextBuffer
object TopScope extends NamespaceBinding

top level namespace scope.
top level namespace scope. only contains the predefined binding for the "xml" prefix which is bound to "http://www.w3.org/XML/1998/namespace"
object Unparsed extends Serializable

This singleton object contains the applyand unapply methods for convenient construction and deconstruction.
object UnprefixedAttribute extends Serializable
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.
object XML extends XMLLoader[Elem]

The object XML provides constants, and functions to load and save XML elements.
The object XML provides constants, and functions to load and save XML elements. Use this when data binding is not desired, i.e. when XML is handled using Symbol nodes.
val XercesClassName: String
object Xhtml
package dtd
package factory
package include
package parsing
package persistent

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(

)

package transform

package xml

Type Members

class Atom[+A] extends SpecialNode with Serializable

trait Attribute extends MetaData

case class Comment(commentText: String) extends SpecialNode with Product with Serializable

class Document extends NodeSeq with XMLEvent with Serializable

class Elem extends Node with Serializable

case class EntityRef(entityName: String) extends SpecialNode with Product with Serializable

type EntityResolver = org.xml.sax.EntityResolver

trait Equality extends Equals

final case class Group(nodes: collection.Seq[Node]) extends Node with Product with Serializable

type InputSource = org.xml.sax.InputSource

case class MalformedAttributeException(msg: String) extends RuntimeException with Product with Serializable

abstract class MetaData extends AbstractIterable[MetaData] with Iterable[MetaData] with Equality with Serializable

case class NamespaceBinding(prefix: String, uri: String, parent: NamespaceBinding) extends Equality with Product with Serializable

abstract class Node extends NodeSeq

class NodeBuffer extends ArrayBuffer[Node] with ScalaVersionSpecificNodeBuffer

abstract class NodeSeq extends AbstractSeq[Node] with collection.immutable.Seq[Node] with ScalaVersionSpecificNodeSeq with Equality with Serializable

class PCData extends Atom[String]

class PrefixedAttribute extends MetaData with Attribute

class PrettyPrinter extends AnyRef

case class ProcInstr(target: String, proctext: String) extends SpecialNode with Product with Serializable

type SAXException = org.xml.sax.SAXException

type SAXParseException = org.xml.sax.SAXParseException

type SAXParser = javax.xml.parsers.SAXParser

trait ScalaVersionSpecificNodeBuffer extends AnyRef

trait ScalaVersionSpecificNodeSeq extends SeqLike[Node, NodeSeq]

abstract class SpecialNode extends Node with XMLEvent

class Text extends Atom[String]

class TextBuffer extends AnyRef

abstract class TypeSymbol extends AnyRef

class Unparsed extends Atom[String]

class UnprefixedAttribute extends MetaData with Attribute

Value Members

object Attribute extends Serializable

object Elem extends Serializable

object Equality

object MetaData extends Serializable

object MinimizeMode extends Enumeration

object Node extends Serializable

object NodeSeq extends Serializable

object Null extends MetaData with Product with Serializable

object PCData extends Serializable

object PrefixedAttribute extends Serializable

object Properties extends PropertiesTrait

object QNode

object ScalaVersionSpecific

object Source

object Text extends Serializable

object TextBuffer

object TopScope extends NamespaceBinding

object Unparsed extends Serializable

object UnprefixedAttribute extends Serializable

object Utility extends TokenTests

object XML extends XMLLoader[Elem]

val XercesClassName: String

object Xhtml

package dtd

package factory

package include

package parsing

package persistent

package pull

package transform

Inherited from AnyRef

Inherited from Any

Ungrouped