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.

    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

XIncludeException

class XIncludeException extends Exception

XIncludeException is the generic superclass for all checked exceptions that may be thrown as a result of a violation of XInclude's rules.

Constructs an XIncludeException with the specified detail message. The error message string message can later be retrieved by the java.lang.Throwable#getMessage method of class java.lang.Throwable.

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

Instance Constructors

  1. new XIncludeException()

    uses null as its error detail message.

  2. new XIncludeException(message: String)

    message

    the detail message.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def addSuppressed(arg0: java.lang.Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def fillInStackTrace(): java.lang.Throwable
    Definition Classes
    Throwable
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def getCause(): java.lang.Throwable
    Definition Classes
    Throwable
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  14. def getMessage(): String
    Definition Classes
    Throwable
  15. 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

  16. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  17. final def getSuppressed(): Array[java.lang.Throwable]
    Definition Classes
    Throwable
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def initCause(arg0: java.lang.Throwable): java.lang.Throwable
    Definition Classes
    Throwable
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  25. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  26. def printStackTrace(): Unit
    Definition Classes
    Throwable
  27. 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

  28. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from java.lang.Exception

Inherited from java.lang.Throwable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped