Woodstox 6.5.1 · com.ctc.wstx.dom.WstxDOMWrappingWriter

Modifier and Type	Field and Description
protected static final String	ERR_NSDECL_WRONG_STATE
protected String	mAutomaticNsPrefix
protected int[]	mAutoNsSeq for NsRepairing mode
protected final WriterConfig	mConfig
protected DOMOutputElement	mCurrElem This element is the current context element, under which all other nodes are added, until matching end element is output.
protected DOMOutputElement	mOpenElement This element is non-null right after a call to either `writeStartElement` and `writeEmptyElement`, and can be used to add attributes and namespace declarations.
protected String	mSuggestedDefNs
pack-priv HashMap<String, String>	mSuggestedPrefixes Map that contains URI-to-prefix entries that point out suggested prefixes for URIs.

Access	Constructor and Description
private	WstxDOMWrappingWriter(WriterConfig cfg, Node treeRoot)

Method Summary

Modifier and Type	Method and Description
protected void	appendLeaf(Node n) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.appendLeaf.
public static WstxDOMWrappingWriter	createFrom(WriterConfig cfg, DOMResult dst)
protected void	createStartElem(String Namespace URI to use: null and empty String denote 'no namespace' nsURI, String prefix, String localName, boolean isEmpty) Method called by all start element write methods.
protected final String	findElemPrefix(String URI of namespace for which we need a prefix nsURI, DOMOutputElement elem) Method called to find an existing prefix for the given namespace, if any exists in the scope.
protected final String	findOrCreateAttrPrefix(String Suggested prefix to bind, if any; may be null to indicate "no preference" suggPrefix, String URI of namespace for which we need a prefix nsURI, DOMOutputElement Currently open start element, on which the attribute will be added. elem) Method called to somehow find a prefix for given namespace, to be used for a new start element; either use an existing one, or generate a new one.
protected final String	generateElemPrefix(String suggPrefix, String nsURI, DOMOutputElement elem) Method called after `findElemPrefix` has returned null, to create and bind a namespace mapping for specified namespace.
public NamespaceContext	getNamespaceContext() Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getNamespaceContext. Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext. Returns the current namespace context.
public String	getPrefix(String the uri the prefix is bound to uri) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getPrefix. Implements javax.xml.stream.XMLStreamWriter.getPrefix. Gets the prefix the uri is bound to.
public Object	getProperty(String The name of the property, may not be null name) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getProperty. Implements javax.xml.stream.XMLStreamWriter.getProperty. Get the value of a feature/property from the underlying implementation
public boolean	isPropertySupported(String name) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.isPropertySupported. Implements org.codehaus.stax2.XMLStreamWriter2.isPropertySupported. Method similar to `javax.xml.stream.XMLOutputFactory#isPropertySupported`, used to determine whether a property is supported by the Writer instance.
protected void	outputAttribute(String nsURI, String prefix, String localName, String value)
public void	setDefaultNamespace(String the uri to bind to the default namespace, may be null uri) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setDefaultNamespace. Implements javax.xml.stream.XMLStreamWriter.setDefaultNamespace. Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
public void	setPrefix(String the prefix to bind to the uri, may not be null prefix, String the uri to bind to the prefix, may be null uri) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setPrefix. Implements javax.xml.stream.XMLStreamWriter.setPrefix. Sets the prefix the uri is bound to.
public boolean	setProperty(String Name of the property to set name, Object Value to set property to. value) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setProperty. Implements org.codehaus.stax2.XMLStreamWriter2.setProperty. Method that can be used to set per-writer properties; a subset of properties one can set via matching `org.codehaus.stax2.XMLOutputFactory2` instance.
private final String	validateElemPrefix(String prefix, String nsURI, DOMOutputElement elem)
public void	writeAttribute(String the local name of the attribute localName, String the value of the attribute value) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream without a prefix.
public void	writeAttribute(String the uri of the prefix for this attribute nsURI, String the local name of the attribute localName, String the value of the attribute value) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream
public void	writeAttribute(String the prefix for this attribute prefix, String the uri of the prefix for this attribute nsURI, String the local name of the attribute localName, String the value of the attribute value) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream
public void	writeDefaultNamespace(String the uri to bind the default namespace to nsURI) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDefaultNamespace. Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace. Writes the default namespace to the stream
public void	writeDTD(String rootName, String systemId, String publicId, String internalSubset) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDTD. Implements org.codehaus.stax2.XMLStreamWriter2.writeDTD.
public void	writeEmptyElement(String local name of the tag, may not be null localName) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEmptyElement(String the uri to bind the tag to, may not be null nsURI, String local name of the tag, may not be null localName) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEmptyElement(String the prefix of the tag, may not be null prefix, String local name of the tag, may not be null localName, String the uri to bind the tag to, may not be null nsURI) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEndDocument() Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEndDocument. Implements javax.xml.stream.XMLStreamWriter.writeEndDocument. Closes any start tags and writes corresponding end tags.
public void	writeEndElement() Implements javax.xml.stream.XMLStreamWriter.writeEndElement. Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
public void	writeNamespace(String the prefix to bind this namespace to prefix, String the uri to bind the prefix to nsURI) Implements javax.xml.stream.XMLStreamWriter.writeNamespace. Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace
public void	writeStartElement(String local name of the tag, may not be null localName) Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output.
public void	writeStartElement(String the namespaceURI of the prefix to use, may not be null nsURI, String local name of the tag, may not be null localName) Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output
public void	writeStartElement(String the prefix of the tag, may not be null prefix, String local name of the tag, may not be null localName, String the uri to bind the prefix to, may not be null nsURI) Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output

Inherited from org.codehaus.stax2.ri.dom.DOMWrappingWriter:: close closeCompletely copyEventFromReader flush getEncoding getLocation getValueEncoder reportUnsupported serializeQNameValue setNamespaceContext setValidationProblemHandler stopValidatingAgainst stopValidatingAgainst throwOutputError throwOutputError validateAgainst writeBinary writeBinary writeBinaryAttribute writeBinaryAttribute writeBoolean writeBooleanAttribute writeCData writeCData writeCharacters writeCharacters writeComment writeDecimal writeDecimalAttribute writeDouble writeDoubleArray writeDoubleArrayAttribute writeDoubleAttribute writeDTD writeEntityRef writeFloat writeFloatArray writeFloatArrayAttribute writeFloatAttribute writeFullEndElement writeInt writeIntArray writeIntArrayAttribute writeIntAttribute writeInteger writeIntegerAttribute writeLong writeLongArray writeLongArrayAttribute writeLongAttribute writeProcessingInstruction writeProcessingInstruction writeQName writeQNameAttribute writeRaw writeRaw writeRaw writeSpace writeSpace writeStartDocument writeStartDocument writeStartDocument writeStartDocument

ERR_NSDECL_WRONG_STATE	back to summary
protected static final String ERR_NSDECL_WRONG_STATE

mAutomaticNsPrefix	back to summary
protected String mAutomaticNsPrefix

mAutoNsSeq	back to summary
protected int[] mAutoNsSeq for NsRepairing mode

mConfig	back to summary
protected final WriterConfig mConfig

mCurrElem	back to summary
protected DOMOutputElement mCurrElem This element is the current context element, under which all other nodes are added, until matching end element is output. Null outside of the main element tree. Note explicit empty element (written using `writeEmptyElement`) will never become current element.

mOpenElement	back to summary
protected DOMOutputElement mOpenElement This element is non-null right after a call to either `writeStartElement` and `writeEmptyElement`, and can be used to add attributes and namespace declarations. Note while this is often the same as `mCurrElem`, it's not always. Specifically, an empty element (written explicitly using `writeEmptyElement`) will become open element but NOT current element. Conversely, regular elements will remain current element when non elements are written (text, comments, PI), but not the open element.

mSuggestedDefNs	back to summary
protected String mSuggestedDefNs

mSuggestedPrefixes	back to summary
pack-priv HashMap<String, String> mSuggestedPrefixes Map that contains URI-to-prefix entries that point out suggested prefixes for URIs. These are populated by calls to `setPrefix`, and they are only used as hints for binding; if there are conflicts, repairing writer can just use some other prefix.

WstxDOMWrappingWriter	back to summary
private WstxDOMWrappingWriter(WriterConfig cfg, Node treeRoot) throws XMLStreamException

Method Detail

appendLeaf	back to summary
protected void appendLeaf(Node n) throws IllegalStateException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.appendLeaf. Annotations @Override

appendLeaf

back to summary

protected void appendLeaf(Node n) throws IllegalStateException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.appendLeaf.

Annotations

@Override

createFrom	back to summary
public static WstxDOMWrappingWriter createFrom(WriterConfig cfg, DOMResult dst) throws XMLStreamException

createStartElem	back to summary
protected void createStartElem(String nsURI, String prefix, String localName, boolean isEmpty) throws XMLStreamException Method called by all start element write methods. Parameters nsURI:String Namespace URI to use: null and empty String denote 'no namespace'

createStartElem

back to summary

protected void createStartElem(String nsURI, String prefix, String localName, boolean isEmpty) throws XMLStreamException

Method called by all start element write methods.

Parameters

nsURI:String: Namespace URI to use: null and empty String denote 'no namespace'

findElemPrefix	back to summary
protected final String findElemPrefix(String nsURI, DOMOutputElement elem) throws XMLStreamException Method called to find an existing prefix for the given namespace, if any exists in the scope. If one is found, it's returned (including "" for the current default namespace); if not, null is returned. Parameters nsURI:String URI of namespace for which we need a prefix

findElemPrefix

back to summary

protected final String findElemPrefix(String nsURI, DOMOutputElement elem) throws XMLStreamException

Method called to find an existing prefix for the given namespace, if any exists in the scope. If one is found, it's returned (including "" for the current default namespace); if not, null is returned.

Parameters

nsURI:String: URI of namespace for which we need a prefix

findOrCreateAttrPrefix	back to summary
protected final String findOrCreateAttrPrefix(String suggPrefix, String nsURI, DOMOutputElement elem) throws XMLStreamException Method called to somehow find a prefix for given namespace, to be used for a new start element; either use an existing one, or generate a new one. If a new mapping needs to be generated, it will also be automatically bound, and necessary namespace declaration output. Parameters suggPrefix:String Suggested prefix to bind, if any; may be null to indicate "no preference" nsURI:String URI of namespace for which we need a prefix elem:DOMOutputElement Currently open start element, on which the attribute will be added.

findOrCreateAttrPrefix

back to summary

protected final String findOrCreateAttrPrefix(String suggPrefix, String nsURI, DOMOutputElement elem) throws XMLStreamException

Method called to somehow find a prefix for given namespace, to be used for a new start element; either use an existing one, or generate a new one. If a new mapping needs to be generated, it will also be automatically bound, and necessary namespace declaration output.

Parameters

suggPrefix:String: Suggested prefix to bind, if any; may be null to indicate "no preference"
nsURI:String: URI of namespace for which we need a prefix
elem:DOMOutputElement: Currently open start element, on which the attribute will be added.

generateElemPrefix	back to summary
protected final String generateElemPrefix(String suggPrefix, String nsURI, DOMOutputElement elem) throws XMLStreamException Method called after `findElemPrefix` has returned null, to create and bind a namespace mapping for specified namespace.

getNamespaceContext	back to summary
public NamespaceContext getNamespaceContext() Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getNamespaceContext. Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext. Doc from javax.xml.stream.XMLStreamWriter.getNamespaceContext. Returns the current namespace context. Returns:NamespaceContext the current NamespaceContext Annotations @Override

getNamespaceContext

back to summary

public NamespaceContext getNamespaceContext()

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getNamespaceContext.

Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Doc from javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Returns the current namespace context.

Returns:NamespaceContext

the current NamespaceContext

Annotations

@Override

getPrefix	back to summary
public String getPrefix(String uri) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getPrefix. Implements javax.xml.stream.XMLStreamWriter.getPrefix. Doc from javax.xml.stream.XMLStreamWriter.getPrefix. Gets the prefix the uri is bound to. Parameters uri:String the uri the prefix is bound to Returns:String the prefix or null Annotations @Override

getPrefix

back to summary

public String getPrefix(String uri)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getPrefix.

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

Doc from javax.xml.stream.XMLStreamWriter.getPrefix.

Gets the prefix the uri is bound to.

Parameters

uri:String: the uri the prefix is bound to

Returns:String

the prefix or null

Annotations

@Override

getProperty	back to summary
public Object getProperty(String name) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getProperty. Implements javax.xml.stream.XMLStreamWriter.getProperty. Doc from javax.xml.stream.XMLStreamWriter.getProperty. Get the value of a feature/property from the underlying implementation Parameters name:String The name of the property, may not be null Returns:Object The value of the property Annotations @Override

getProperty

back to summary

public Object getProperty(String name)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.getProperty.

Implements javax.xml.stream.XMLStreamWriter.getProperty.

Doc from javax.xml.stream.XMLStreamWriter.getProperty.

Get the value of a feature/property from the underlying implementation

Parameters

name:String: The name of the property, may not be null

Returns:Object

The value of the property

Annotations

@Override

isPropertySupported back to summary

isPropertySupported	back to summary
public boolean isPropertySupported(String name) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.isPropertySupported. Implements org.codehaus.stax2.XMLStreamWriter2.isPropertySupported. Doc from org.codehaus.stax2.XMLStreamWriter2.isPropertySupported. Method similar to `javax.xml.stream.XMLOutputFactory#isPropertySupported`, used to determine whether a property is supported by the Writer instance. This means that this method may return false for some properties that the output factory does support: specifically, it should only return true if the value is mutable on per-instance basis. False means that either the property is not recognized, or is not mutable via writer instance. Annotations @Override

public boolean isPropertySupported(String name)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.isPropertySupported.

Implements org.codehaus.stax2.XMLStreamWriter2.isPropertySupported.

Doc from org.codehaus.stax2.XMLStreamWriter2.isPropertySupported.

Method similar to javax.xml.stream.XMLOutputFactory#isPropertySupported, used to determine whether a property is supported by the Writer instance. This means that this method may return false for some properties that the output factory does support: specifically, it should only return true if the value is mutable on per-instance basis. False means that either the property is not recognized, or is not mutable via writer instance.

Annotations

@Override

outputAttribute	back to summary
protected void outputAttribute(String nsURI, String prefix, String localName, String value) throws XMLStreamException

setDefaultNamespace	back to summary
public void setDefaultNamespace(String uri) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setDefaultNamespace. Implements javax.xml.stream.XMLStreamWriter.setDefaultNamespace. Doc from javax.xml.stream.XMLStreamWriter.setDefaultNamespace. Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope. Parameters uri:String the uri to bind to the default namespace, may be null Annotations @Override

setDefaultNamespace

back to summary

public void setDefaultNamespace(String uri)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setDefaultNamespace.

Implements javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Doc from javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.

Parameters

uri:String: the uri to bind to the default namespace, may be null

Annotations

@Override

setPrefix	back to summary
public void setPrefix(String prefix, String uri) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setPrefix. Implements javax.xml.stream.XMLStreamWriter.setPrefix. Doc from javax.xml.stream.XMLStreamWriter.setPrefix. Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope. Parameters prefix:String the prefix to bind to the uri, may not be null uri:String the uri to bind to the prefix, may be null Annotations @Override Exceptions XMLStreamException: if an error occurs

setPrefix

back to summary

public void setPrefix(String prefix, String uri) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setPrefix.

Implements javax.xml.stream.XMLStreamWriter.setPrefix.

Doc from javax.xml.stream.XMLStreamWriter.setPrefix.

Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.

Parameters

prefix:String: the prefix to bind to the uri, may not be null
uri:String: the uri to bind to the prefix, may be null

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

setProperty back to summary

setProperty	back to summary
public boolean setProperty(String name, Object value) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setProperty. Implements org.codehaus.stax2.XMLStreamWriter2.setProperty. Doc from org.codehaus.stax2.XMLStreamWriter2.setProperty. Method that can be used to set per-writer properties; a subset of properties one can set via matching `org.codehaus.stax2.XMLOutputFactory2` instance. Exactly which methods are mutable is implementation specific. Parameters name:String Name of the property to set value:Object Value to set property to. Returns:boolean True, if the specified property was succesfully set to specified value; false if its value was not changed Annotations @Override

public boolean setProperty(String name, Object value)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.setProperty.

Implements org.codehaus.stax2.XMLStreamWriter2.setProperty.

Doc from org.codehaus.stax2.XMLStreamWriter2.setProperty.

Method that can be used to set per-writer properties; a subset of properties one can set via matching org.codehaus.stax2.XMLOutputFactory2 instance. Exactly which methods are mutable is implementation specific.

Parameters

name:String: Name of the property to set
value:Object: Value to set property to.

Returns:boolean

True, if the specified property was succesfully set to specified value; false if its value was not changed

Annotations

@Override

validateElemPrefix	back to summary
private final String validateElemPrefix(String prefix, String nsURI, DOMOutputElement elem) throws XMLStreamException

writeAttribute	back to summary
public void writeAttribute(String localName, String value) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream without a prefix. Parameters localName:String the local name of the attribute value:String the value of the attribute Annotations @Override Exceptions XMLStreamException: if an error occurs

writeAttribute

back to summary

public void writeAttribute(String localName, String value) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute.

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream without a prefix.

Parameters

localName:String: the local name of the attribute
value:String: the value of the attribute

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeAttribute	back to summary
public void writeAttribute(String nsURI, String localName, String value) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream Parameters nsURI:String the uri of the prefix for this attribute localName:String the local name of the attribute value:String the value of the attribute Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeAttribute

back to summary

public void writeAttribute(String nsURI, String localName, String value) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute.

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

Parameters

nsURI:String: the uri of the prefix for this attribute
localName:String: the local name of the attribute
value:String: the value of the attribute

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeAttribute	back to summary
public void writeAttribute(String prefix, String nsURI, String localName, String value) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. Writes an attribute to the output stream Parameters prefix:String the prefix for this attribute nsURI:String the uri of the prefix for this attribute localName:String the local name of the attribute value:String the value of the attribute Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeAttribute

back to summary

public void writeAttribute(String prefix, String nsURI, String localName, String value) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeAttribute.

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

Parameters

prefix:String: the prefix for this attribute
nsURI:String: the uri of the prefix for this attribute
localName:String: the local name of the attribute
value:String: the value of the attribute

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeDefaultNamespace	back to summary
public void writeDefaultNamespace(String nsURI) Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDefaultNamespace. Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace. Doc from javax.xml.stream.XMLStreamWriter.writeDefaultNamespace. Writes the default namespace to the stream Parameters nsURI:String the uri to bind the default namespace to Annotations @Override

writeDefaultNamespace

back to summary

public void writeDefaultNamespace(String nsURI)

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDefaultNamespace.

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Doc from javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Writes the default namespace to the stream

Parameters

nsURI:String: the uri to bind the default namespace to

Annotations

@Override

writeDTD	back to summary
public void writeDTD(String rootName, String systemId, String publicId, String internalSubset) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDTD. Implements org.codehaus.stax2.XMLStreamWriter2.writeDTD. Annotations @Override

writeDTD

back to summary

public void writeDTD(String rootName, String systemId, String publicId, String internalSubset) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeDTD.

Implements org.codehaus.stax2.XMLStreamWriter2.writeDTD.

Annotations

@Override

writeEmptyElement	back to summary
public void writeEmptyElement(String localName) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Parameters localName:String local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: if an error occurs

writeEmptyElement

back to summary

public void writeEmptyElement(String localName) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Parameters

localName:String: local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeEmptyElement	back to summary
public void writeEmptyElement(String nsURI, String localName) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Parameters nsURI:String the uri to bind the tag to, may not be null localName:String local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeEmptyElement

back to summary

public void writeEmptyElement(String nsURI, String localName) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Parameters

nsURI:String: the uri to bind the tag to, may not be null
localName:String: local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeEmptyElement	back to summary
public void writeEmptyElement(String prefix, String localName, String nsURI) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Parameters prefix:String the prefix of the tag, may not be null localName:String local name of the tag, may not be null nsURI:String the uri to bind the tag to, may not be null Annotations @Override Exceptions XMLStreamException: if an error occurs

writeEmptyElement

back to summary

public void writeEmptyElement(String prefix, String localName, String nsURI) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Parameters

prefix:String: the prefix of the tag, may not be null
localName:String: local name of the tag, may not be null
nsURI:String: the uri to bind the tag to, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeEndDocument	back to summary
public void writeEndDocument() Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEndDocument. Implements javax.xml.stream.XMLStreamWriter.writeEndDocument. Doc from javax.xml.stream.XMLStreamWriter.writeEndDocument. Closes any start tags and writes corresponding end tags. Annotations @Override

writeEndDocument

back to summary

public void writeEndDocument()

Implements abstract org.codehaus.stax2.ri.dom.DOMWrappingWriter.writeEndDocument.

Implements javax.xml.stream.XMLStreamWriter.writeEndDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeEndDocument.

Closes any start tags and writes corresponding end tags.

Annotations

@Override

writeEndElement	back to summary
public void writeEndElement() Implements javax.xml.stream.XMLStreamWriter.writeEndElement. Doc from javax.xml.stream.XMLStreamWriter.writeEndElement. Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event. Annotations @Override

writeEndElement

back to summary

public void writeEndElement()

Implements javax.xml.stream.XMLStreamWriter.writeEndElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEndElement.

Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.

Annotations

@Override

writeNamespace	back to summary
public void writeNamespace(String prefix, String nsURI) throws XMLStreamException Implements javax.xml.stream.XMLStreamWriter.writeNamespace. Doc from javax.xml.stream.XMLStreamWriter.writeNamespace. Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace Parameters prefix:String the prefix to bind this namespace to nsURI:String the uri to bind the prefix to Annotations @Override Exceptions XMLStreamException: if an error occurs

writeNamespace

back to summary

public void writeNamespace(String prefix, String nsURI) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeNamespace.

Doc from javax.xml.stream.XMLStreamWriter.writeNamespace.

Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace

Parameters

prefix:String: the prefix to bind this namespace to
nsURI:String: the uri to bind the prefix to

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartElement	back to summary
public void writeStartElement(String localName) throws XMLStreamException Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed. Parameters localName:String local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartElement

back to summary

public void writeStartElement(String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.

Parameters

localName:String: local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartElement	back to summary
public void writeStartElement(String nsURI, String localName) throws XMLStreamException Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output Parameters nsURI:String the namespaceURI of the prefix to use, may not be null localName:String local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeStartElement

back to summary

public void writeStartElement(String nsURI, String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

Parameters

nsURI:String: the namespaceURI of the prefix to use, may not be null
localName:String: local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeStartElement	back to summary
public void writeStartElement(String prefix, String localName, String nsURI) throws XMLStreamException Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output Parameters prefix:String the prefix of the tag, may not be null localName:String local name of the tag, may not be null nsURI:String the uri to bind the prefix to, may not be null Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartElement

back to summary

public void writeStartElement(String prefix, String localName, String nsURI) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

Parameters

prefix:String: the prefix of the tag, may not be null
localName:String: local name of the tag, may not be null
nsURI:String: the uri to bind the prefix to, may not be null

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

public Class WstxDOMWrappingWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail