org.codehaus.staxmate.out

Class SMOutputDocument

java.lang.Object

org.codehaus.staxmate.out.SMOutputtable

org.codehaus.staxmate.out.SMOutputContainer

org.codehaus.staxmate.out.SMRootFragment

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

_active

Fields inherited from class org.codehaus.staxmate.out.SMOutputContainer

_context, _firstChild, _lastChild, _parent

Fields inherited from class org.codehaus.staxmate.out.SMOutputtable

_next

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SMOutputDocument(SMOutputContext ctxt)
protected	SMOutputDocument(SMOutputContext ctxt, String version, String encoding)
protected	SMOutputDocument(SMOutputContext ctxt, String version, String encoding, boolean standalone)

Method Summary

Modifier and Type	Method and Description
void	addDoctypeDecl(String rootName, String systemId, String publicId)
void	addDoctypeDecl(String rootName, String systemId, String publicId, 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, _forceOutput, _output, closeRootAndWriter, getPath

Methods inherited from class org.codehaus.staxmate.out.SMOutputContainer

_closeAllButLastChild, _closeAndOutputChildren, _forceChildOutput, _linkNewChild, _throwClosed, _throwRelinking, _verifyNamespaceArg, addAndReleaseBuffered, addBuffered, addCData, addCData, addCharacters, addCharacters, addComment, addElement, addElement, addElementWithCharacters, addEntityRef, addProcessingInstruction, addValue, addValue, addValue, addValue, addValue, addValue, createBufferedElement, createBufferedFragment, getContext, getNamespace, getNamespace, getParent, getPath, setIndentation

Methods inherited from class org.codehaus.staxmate.out.SMOutputtable

_linkNext, getNext

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 XMLStreamException

Throws:

XMLStreamException

SMOutputDocument

protected SMOutputDocument(SMOutputContext ctxt,
                           String version,
                           String encoding)
                    throws XMLStreamException

Throws:

XMLStreamException

SMOutputDocument

protected SMOutputDocument(SMOutputContext ctxt,
                           String version,
                           String encoding,
                           boolean standalone)
                    throws XMLStreamException

Throws:

XMLStreamException

Method Detail

addDoctypeDecl

public void addDoctypeDecl(String rootName,
                           String systemId,
                           String publicId)
                    throws XMLStreamException

Throws:

XMLStreamException

addDoctypeDecl

public void addDoctypeDecl(String rootName,
                           String systemId,
                           String publicId,
                           String intSubset)
                    throws XMLStreamException

Throws:

XMLStreamException

closeRoot

public void closeRoot()
               throws 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:

XMLStreamException