org.codehaus.staxmate.out
Class SMOutputDocument

java.lang.Object
  extended by org.codehaus.staxmate.out.SMOutputtable
      extended by org.codehaus.staxmate.out.SMOutputContainer
          extended by org.codehaus.staxmate.out.SMRootFragment
              extended by org.codehaus.staxmate.out.SMOutputDocument

public class SMOutputDocument
extends SMRootFragment

Output class that models a full XML document, with xml declaration.


Field Summary
 
Fields inherited from class org.codehaus.staxmate.out.SMRootFragment
mActive
 
Fields inherited from class org.codehaus.staxmate.out.SMOutputtable
mNext
 
Constructor Summary
protected SMOutputDocument(SMOutputContext ctxt)
           
protected SMOutputDocument(SMOutputContext ctxt, java.lang.String version, java.lang.String encoding)
           
protected SMOutputDocument(SMOutputContext ctxt, java.lang.String version, java.lang.String encoding, boolean standalone)
           
 
Method Summary
 void addDoctypeDecl(java.lang.String rootName, java.lang.String systemId, java.lang.String publicId)
           
 void addDoctypeDecl(java.lang.String rootName, java.lang.String systemId, java.lang.String publicId, java.lang.String intSubset)
           
 void closeRoot()
          Method that HAS to be called when all additions have been done via StaxMate API.
 
Methods inherited from class org.codehaus.staxmate.out.SMRootFragment
canOutputNewChild, childReleased, doOutput, forceOutput, getPath
 
Methods inherited from class org.codehaus.staxmate.out.SMOutputContainer
addAndReleaseBuffered, addBuffered, addCData, addCData, addCharacters, addCharacters, addCharacters, addComment, addElement, addElement, addEntityRef, addProcessingInstruction, closeAllButLastChild, closeAndOutputChildren, createBufferedElement, createBufferedFragment, forceChildOutput, getContext, getNamespace, getNamespace, getParent, getPath, linkNewChild, setIndentation, throwBuffered, throwClosed, throwRelinking
 
Methods inherited from class org.codehaus.staxmate.out.SMOutputtable
getNext, linkNext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SMOutputDocument

protected SMOutputDocument(SMOutputContext ctxt)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

SMOutputDocument

protected SMOutputDocument(SMOutputContext ctxt,
                           java.lang.String version,
                           java.lang.String encoding)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

SMOutputDocument

protected SMOutputDocument(SMOutputContext ctxt,
                           java.lang.String version,
                           java.lang.String encoding,
                           boolean standalone)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException
Method Detail

addDoctypeDecl

public void addDoctypeDecl(java.lang.String rootName,
                           java.lang.String systemId,
                           java.lang.String publicId)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

addDoctypeDecl

public void addDoctypeDecl(java.lang.String rootName,
                           java.lang.String systemId,
                           java.lang.String publicId,
                           java.lang.String intSubset)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

closeRoot

public void closeRoot()
               throws javax.xml.stream.XMLStreamException
Method that HAS to be called when all additions have been done via StaxMate API. Since it is possible that the underlying stream writer may be buffering some parts, it needs to be informed of the closure.

Overrides:
closeRoot in class SMRootFragment
Throws:
javax.xml.stream.XMLStreamException