Packages

package root

Definition Classes: root

package scala

Definition Classes: root

package xml

This library provides support for the XML literal syntax in Scala programs.

val planets: scala.xml.Elem = <planets>
  <planet id="earth">
    <title>Earth</title>
    <mass unit="kg">5.9742e24</mass>
    <radius unit="m">6378.14e3</radius>
  </planet>
  <planet id="mars">
    <title>Mars</title>
    <mass unit="kg">0.64191e24</mass>
    <radius unit="m">3397.0e3</radius>
  </planet>
</planets>

Additionally, you can mix Scala expressions in your XML elements by using the curly brace notation:

val sunMass = 1.99e30
val sunRadius = 6.96e8
val star = <star>
  <title>Sun</title>
  <mass unit="kg">{ sunMass }</mass>
  <radius unit="m">{ sunRadius }</radius>
  <surface unit="m²">{ 4 * Math.PI * Math.pow(sunRadius, 2) }</surface>
  <volume unit="m³">{ 4/3 * Math.PI * Math.pow(sunRadius, 3) }</volume>
</star>

An XML element, for example <star/> and <planet/>, is represented in this library as a case class, scala.xml.Elem.

The sub-elements of XML values share a common base class, scala.xml.Node.

However, the non-element declarations found in XML files share a different common base class, scala.xml.dtd.Decl. Additionally, document type declarations are represented by a different trait, scala.xml.dtd.DTD.

For reading and writing XML data to and from files, see scala.xml.XML. The default parser of XML data is the Xerces parser and is provided in Java by javax.xml.parsers.SAXParser.

A less greedy XML reader can return data as a sequential collection of events, see scala.xml.pull.XMLEventReader.

For more control of the input, use the parser written in Scala that is provided, scala.xml.parsing.ConstructingParser.

For working with XHTML input, use scala.xml.parsing.XhtmlParser.

For more control of the output, use the scala.xml.PrettyPrinter.

Utility methods for working with XML data are provided in scala.xml.Utility.

XML values in Scala are immutable, but you can traverse and transform XML data with a scala.xml.transform.RuleTransformer.

Definition Classes: scala

package dtd

Definition Classes: xml

package factory

Definition Classes: xml

package include

Definition Classes: xml

package parsing

Definition Classes: xml

package persistent

Definition Classes: xml

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

package transform

Definition Classes: xml

Atom

Attribute

Comment

Document

Elem

EntityRef

Equality

Group

MalformedAttributeException

MetaData

MinimizeMode

NamespaceBinding

Node

NodeBuffer

NodeSeq

Null

PCData

PrefixedAttribute

PrettyPrinter

ProcInstr

Properties

QNode

Source

SpecialNode

Text

TextBuffer

TopScope

TypeSymbol

Unparsed

UnprefixedAttribute

Utility

XML

Xhtml

scala.xml

Xhtml

object Xhtml

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Xhtml
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
def sequenceToXML(children: collection.Seq[Node], pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = false, preserveWhitespace: Boolean = false, minimizeTags: Boolean = true): Unit
Amounts to calling toXhtml(node, ...) with the given parameters on each node.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def toXhtml(x: Node, pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = false, preserveWhitespace: Boolean = false, minimizeTags: Boolean = true): Unit
def toXhtml(nodeSeq: NodeSeq): String
Convenience function: amounts to calling toXhtml(node) on each node in the sequence.
Convenience function: amounts to calling toXhtml(node) on each node in the sequence.
nodeSeq
the node sequence
def toXhtml(node: Node): String
Convenience function: same as toXhtml(node, false, false)
Convenience function: same as toXhtml(node, false, false)
node
the node
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )

Packages

Xhtml

object Xhtml

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Xhtml 

object Xhtml

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Xhtml