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.

    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 include
    Definition Classes
    xml
  • package sax
    Definition Classes
    include
  • CircularIncludeException
  • UnavailableResourceException
  • XIncludeException
c

scala.xml.include

CircularIncludeException

class CircularIncludeException extends XIncludeException

A CircularIncludeException is thrown when an included document attempts to include itself or one of its ancestor documents.

Linear Supertypes
XIncludeException, java.lang.Exception, java.lang.Throwable, java.io.Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircularIncludeException
  2. XIncludeException
  3. Exception
  4. Throwable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CircularIncludeException()

    Constructs a CircularIncludeException with null.

    Constructs a CircularIncludeException with null. as its error detail message.

  2. new CircularIncludeException(message: String)

Value Members

  1. final def addSuppressed(arg0: java.lang.Throwable): Unit
    Definition Classes
    Throwable
  2. def fillInStackTrace(): java.lang.Throwable
    Definition Classes
    Throwable
  3. def getCause(): java.lang.Throwable
    Definition Classes
    Throwable
  4. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  5. def getMessage(): String
    Definition Classes
    Throwable
  6. def getRootCause(): Throwable

    When an IOException, MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException.

    When an IOException, MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException. This method allows you to retrieve the original exception. It returns null if no such exception caused this XIncludeException.

    returns

    Throwable the underlying exception which caused the XIncludeException to be thrown

    Definition Classes
    XIncludeException
  7. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  8. final def getSuppressed(): Array[java.lang.Throwable]
    Definition Classes
    Throwable
  9. def initCause(arg0: java.lang.Throwable): java.lang.Throwable
    Definition Classes
    Throwable
  10. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  11. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  12. def printStackTrace(): Unit
    Definition Classes
    Throwable
  13. def setRootCause(nestedException: Throwable): Unit

    When an IOException, MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException.

    When an IOException, MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException. This method allows you to store the original exception.

    nestedException

    the underlying exception which caused the XIncludeException to be thrown

    Definition Classes
    XIncludeException
  14. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  15. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any