summaryrefslogtreecommitdiff
path: root/sources
diff options
context:
space:
mode:
authorburaq <buraq@epfl.ch>2005-04-26 14:23:15 +0000
committerburaq <buraq@epfl.ch>2005-04-26 14:23:15 +0000
commitb630d0e2d9df946ea30eb67223e29084d25ddf8e (patch)
tree75773f090be67aebe98201254a50f84f5a87a90d /sources
parent6a415fa5cef84c98f3dbfb1a0e9d06a1751724c6 (diff)
downloadscala-b630d0e2d9df946ea30eb67223e29084d25ddf8e.tar.gz
scala-b630d0e2d9df946ea30eb67223e29084d25ddf8e.tar.bz2
scala-b630d0e2d9df946ea30eb67223e29084d25ddf8e.zip
added docu-ii
Diffstat (limited to 'sources')
-rw-r--r--sources/scala/xml/Document.scala74
1 files changed, 74 insertions, 0 deletions
diff --git a/sources/scala/xml/Document.scala b/sources/scala/xml/Document.scala
new file mode 100644
index 0000000000..a19a2316f3
--- /dev/null
+++ b/sources/scala/xml/Document.scala
@@ -0,0 +1,74 @@
+package scala.xml;
+
+/** 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.
+ */
+class Document extends NodeSeq {
+
+ /** An ordered list of child information items, in document
+ * order. The list contains exactly one element information item. The
+ * list also contains one processing instruction information item for
+ * each processing instruction outside the document element, and one
+ * comment information item for each comment outside the document
+ * element. Processing instructions and comments within the DTD are
+ * excluded. If there is a document type declaration, the list also
+ * contains a document type declaration information item.
+ */
+ var children: Seq[Node] = _;
+
+ /** The element information item corresponding to the document element. */
+ var docElem: Node = _;
+
+ /** The dtd that comes with the document, if any */
+ var dtd: scala.xml.dtd.DTD = _;
+
+ /** An unordered set of notation information items, one for each notation
+ * declared in the DTD. If any notation is multiply declared, this property
+ * has no value.
+ */
+ def notations: Seq[scala.xml.dtd.NotationDecl] =
+ dtd.notations;
+
+ /** An unordered set of unparsed entity information items, one for each
+ * unparsed entity declared in the DTD.
+ */
+ def unparsedEntities: Seq[scala.xml.dtd.EntityDecl] =
+ dtd.unparsedEntities;
+
+ /** The base URI of the document entity. */
+ var baseURI: String = _;
+
+ /** The name of the character encoding scheme in which the document entity
+ * is expressed.
+ */
+ var encoding: Option[String] = _;
+
+ /** An indication of the standalone status of the document, either
+ * true or false. This property is derived from the optional standalone
+ * document declaration in the XML declaration at the beginning of the
+ * document entity, and has no value (None) if there is no standalone
+ * document declaration.
+ */
+ var standAlone: Option[Boolean] = _;
+
+ /** A string representing the XML version of the document. This
+ * property is derived from the XML declaration optionally present at
+ * the beginning of the document entity, and has no value (None) if there is
+ * no XML declaration.
+ */
+ var version: Option[String] = _;
+
+ /** 9. This property is not strictly speaking part of the infoset of
+ * the document. Rather it is an indication of whether the processor
+ * has read the complete DTD. Its value is a boolean. If it is false,
+ * then certain properties (indicated in their descriptions below) may
+ * be unknown. If it is true, those properties are never unknown.
+ */
+ var allDeclarationsProcessed = false;
+
+ // methods for NodeSeq
+
+ def theSeq = docElem;
+
+}