class Document
Extends Element
Represents a full XML document, including PIs, a doctype, etc. A Document has a single child that can be accessed by root(). Note that if you want to have an XML declaration written for a document you create, you must add one; REXML documents do not write a default declaration for you. See |DECLARATION| and |write|.
Methods
Aliases
<<
is a synonym for
add
Methods
add
We override this, because XMLDecls and DocTypes must go at the start of the document
doc_type
Returns
the DocType child of the document, if one exists, and nil otherwise.
Document
Stream parser. The source will be parsed as a Stream. If a block is supplied, yield will be called for tag starts, ends, and text. If a listener is supplied, the listener will also be notified, by calling the appropriate methods on events. The arguments to the block will be: IF TAG START: "tag name", { attributes } (possibly empty) IF TEXT: "text" IF TAG END: "/tag name" The listener must supply the following methods: tag_start( "name", { attributes } ) tag_end( "name" ) text( "text" ) instruction( "name", "instruction" ) comment( "comment" ) doctype( "name", *contents )
encoding
Returns
the XMLDecl encoding of this document as a String. If no XMLDecl has been set, returns the default encoding.
parse
This and parse_stream could have been combined, but separating them improves the speed of REXML
root
Returns
the root Element of the document, or nil if this document has no children.
stand_alone
Returns
the XMLDecl standalone value of this document as a String. If no XMLDecl has been set, returns the default setting.
version
Returns
the XMLDecl version of this document as a String. If no XMLDecl has been set, returns the default version.
write
Write the XML tree out, optionally with indent. This writes out the entire XML document, including XML declarations, doctype declarations, and processing instructions (if any are given). A controversial point is whether Document should always write the XML declaration (<?xml version='1.0'?>) whether or not one is given by the user (or source document). REXML does not write one if one was not specified, because it adds unneccessary bandwidth to applications such as XML-RPC.
xml_decl
Returns
the XMLDecl of this document; if no XMLDecl has been set, the default declaration is returned.