<!DOCTYPE class>
<class name='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|.
  <attribute name='context' type='accessor'/>
  <method name='initialize'>
    <argument default='nil' name='source'>
      if supplied, must be a Document, String, or IO.  Documents have their context and Element attributes cloned. Strings are expected to be valid XML documents.  IOs are expected to be sources of valid XML documents. 
    </argument>
    <argument default='{}' name='context'>
      if supplied, contains the context of the document; this should be a Hash. NOTE that I'm not sure what the context is for; I cloned it out of the Electric XML API (in which it also seems to do nothing), and it is now legacy.  It may do something, someday... it may disappear.
    </argument>
     Constructor 
  </method>
  <method name='clone'>
     Should be obvious
  </method>
  <method name='add'>
    <argument name='child'/>
     We override this, because XMLDecls and DocTypes must go at the start of the document
  </method>
  <alias alias='&lt;&lt;' orig='add'>
    
  </alias>
  <method name='root'>
    <return>
      the root Element of the document, or nil if this document has no children.
    </return>
     
  </method>
  <method name='doc_type'>
    <return>
      the DocType child of the document, if one exists, and nil otherwise.
    </return>
     
  </method>
  <method name='xml_decl'>
    <return>
      the XMLDecl of this document; if no XMLDecl has been set, the default declaration is returned.
    </return>
     
  </method>
  <method name='version'>
    <return>
      the XMLDecl version of this document as a String. If no XMLDecl has been set, returns the default version.
    </return>
     
  </method>
  <method name='encoding'>
    <return>
      the XMLDecl encoding of this document as a String. If no XMLDecl has been set, returns the default encoding.
    </return>
     
  </method>
  <method name='stand_alone'>
    <return>
      the XMLDecl standalone value of this document as a String. If no XMLDecl has been set, returns the default setting.
    </return>
     
  </method>
  <method name='write'>
    <argument name='output'>
      an object which supports '&lt;&lt; string'; this is where the document will be written 
    </argument>
    <argument default='0' name='indent'>
      (optional) if given, the starting indent for the lines in the document.
    </argument>
     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 (&lt;?xml version='1.0'?&gt;) 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. 
  </method>
  <method name='Document'>
    <argument name='parse_stream'/>
    <argument name='source'/>
    <argument name='listener'/>
     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 )
  </method>
  <method name='parse'>
    <argument name='source'/>
     This and parse_stream could have been combined, but separating them improves the speed of REXML
  </method>
</class>