Woodstox 6.5.1 · com.ctc.wstx.sw.BaseNsStreamWriter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected static final String	ERR_NSDECL_WRONG_STATE
protected final boolean	mAutomaticNS True, if writer needs to automatically output namespace declarations (we are in repairing mode)
pack-priv static final int	MAX_POOL_SIZE Although pooled objects are small, let's limit the pool size nonetheless, to optimize memory usage for deeply nested documents.
protected SimpleOutputElement	mCurrElem
protected final EmptyElementHandler	mEmptyElementHandler
protected SimpleOutputElement	mOutputElemPool
protected int	mPoolSize
protected NamespaceContext	mRootNsContext Optional "root" namespace context that application can set.
protected static final String	sPrefixXml
protected static final String	sPrefixXmlns

Access	Constructor and Description
public	BaseNsStreamWriter(XmlWriter xw, String enc, WriterConfig cfg, boolean repairing)

Method Summary

Modifier and Type	Method and Description
protected void	checkStartElement(String localName, String prefix) Method that is called to ensure that we can start writing an element, both from structural point of view, and from syntactic (close previously open start element, if any).
protected void	closeStartElement(boolean If true, the element being closed is an empty element; if false, a separate stand-alone start element. emptyElem) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.closeStartElement. Method called to close an open start element, when another main-level element (not namespace declaration or attribute) is being output; except for end element which is handled differently.
public abstract void	doSetPrefix(String prefix, String uri)
protected final void	doWriteAttr(String localName, String nsURI, String prefix, String value)
protected final void	doWriteAttr(String localName, String nsURI, String prefix, char[] buf, int start, int len)
protected void	doWriteDefaultNs(String nsURI)
protected void	doWriteEndTag(QName Name that the closing element should have; null if whatever is in stack should be used expName, boolean If true, is allowed to create the empty element if the closing element was truly empty; if false, has to write the full empty element no matter what allowEmpty)
protected void	doWriteNamespace(String prefix, String nsURI)
protected final void	doWriteStartTag(String localName)
protected final void	doWriteStartTag(String prefix, String localName)
public QName	getCurrentElementName() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getCurrentElementName. Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Method that can be used to access name information of the innermost (top) element in the element stack.
public NamespaceContext	getNamespaceContext() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getNamespaceContext. Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext. Returns the current namespace context.
public String	getNamespaceURI(String prefix) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getNamespaceURI. Implements org.codehaus.stax2.validation.ValidationContext.getNamespaceURI. Method that can be called by the validator to resolve a namespace prefix of the currently active top-level element.
public String	getPrefix(String the uri the prefix is bound to uri) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getPrefix. Implements javax.xml.stream.XMLStreamWriter.getPrefix. Gets the prefix the uri is bound to.
protected String	getTopElementDesc() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getTopElementDesc. Method needed for error message generation
public abstract void	setDefaultNamespace(String the uri to bind to the default namespace, may be null uri) Redeclares javax.xml.stream.XMLStreamWriter.setDefaultNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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	setNamespaceContext(NamespaceContext the namespace context to use for this writer, may not be null ctxt) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.setNamespaceContext. Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext. Note Root namespace context works best if automatic prefix creation ("namespace/prefix repairing" in StAX lingo) is enabled.
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 com.ctc.wstx.sw.BaseStreamWriter.setPrefix. Implements javax.xml.stream.XMLStreamWriter.setPrefix. Sets the prefix the uri is bound to.
public void	writeAttribute(String the local name of the attribute localName, String the value of the attribute value) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. It's assumed calling this method implies caller just wants to add an attribute that does not belong to any namespace; as such no namespace checking or prefix generation is needed.
public abstract 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) Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeAttribute. Writes an attribute to the output stream
public abstract 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) Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeAttribute. Writes an attribute to the output stream
public abstract void	writeDefaultNamespace(String the uri to bind the default namespace to nsURI) Redeclares javax.xml.stream.XMLStreamWriter.writeDefaultNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeDefaultNamespace. Writes the default namespace to the stream
public void	writeEmptyElement(String local name of the tag, may not be null localName) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Note It is assumed caller just wants the element to belong to whatever is the current default namespace.
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 com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEndElement() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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	writeEndElement(QName name) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEndElement. Method called by `javax.xml.stream.XMLEventWriter` implementation (instead of the version that takes no argument), so that we can verify it does match the start element, if necessary
public void	writeFullEndElement() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeFullEndElement. Implements org.codehaus.stax2.XMLStreamWriter2.writeFullEndElement. Similar to `writeEndElement`, but never allows implicit creation of empty elements.
public abstract void	writeNamespace(String the prefix to bind this namespace to prefix, String the uri to bind the prefix to nsURI) Redeclares javax.xml.stream.XMLStreamWriter.writeNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. This method is assumed to just use default namespace (if any), and no further checks should be done.
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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. 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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output
public abstract void	writeStartElement(StartElement elem) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Convenience method needed by `javax.xml.stream.XMLEventWriter` implementation, to use when writing a start element, and possibly its attributes and namespace declarations.
protected abstract void	writeStartOrEmpty(String localName, String nsURI)
protected abstract void	writeStartOrEmpty(String prefix, String localName, String nsURI)
protected void	writeTypedAttribute(String prefix, String nsURI, String localName, AsciiValueEncoder enc) Implements abstract com.ctc.wstx.sw.TypedStreamWriter.writeTypedAttribute. Method that will write attribute with value that is known not to require additional escaping.

ERR_NSDECL_WRONG_STATE	back to summary
protected static final String ERR_NSDECL_WRONG_STATE

mAutomaticNS	back to summary
protected final boolean mAutomaticNS True, if writer needs to automatically output namespace declarations (we are in repairing mode)

MAX_POOL_SIZE	back to summary
pack-priv static final int MAX_POOL_SIZE Although pooled objects are small, let's limit the pool size nonetheless, to optimize memory usage for deeply nested documents. In general, even just low number like 4 levels gets decent return, but 8 should get 99% hit rate.

mCurrElem	back to summary
protected SimpleOutputElement mCurrElem

mEmptyElementHandler	back to summary
protected final EmptyElementHandler mEmptyElementHandler

mOutputElemPool	back to summary
protected SimpleOutputElement mOutputElemPool

mPoolSize	back to summary
protected int mPoolSize

mRootNsContext	back to summary
protected NamespaceContext mRootNsContext Optional "root" namespace context that application can set. If so, it can be used to lookup namespace/prefix mappings

sPrefixXml	back to summary
protected static final String sPrefixXml

sPrefixXmlns	back to summary
protected static final String sPrefixXmlns

BaseNsStreamWriter	back to summary
public BaseNsStreamWriter(XmlWriter xw, String enc, WriterConfig cfg, boolean repairing)

Method Detail

checkStartElement	back to summary
protected void checkStartElement(String localName, String prefix) throws XMLStreamException Method that is called to ensure that we can start writing an element, both from structural point of view, and from syntactic (close previously open start element, if any).

closeStartElement	back to summary
protected void closeStartElement(boolean emptyElem) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.closeStartElement. Method called to close an open start element, when another main-level element (not namespace declaration or attribute) is being output; except for end element which is handled differently. Parameters emptyElem:boolean If true, the element being closed is an empty element; if false, a separate stand-alone start element. Annotations @Override

closeStartElement

back to summary

protected void closeStartElement(boolean emptyElem) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.closeStartElement.

Method called to close an open start element, when another main-level element (not namespace declaration or attribute) is being output; except for end element which is handled differently.

Parameters

emptyElem:boolean: If true, the element being closed is an empty element; if false, a separate stand-alone start element.

Annotations

@Override

doSetPrefix	back to summary
public abstract void doSetPrefix(String prefix, String uri) throws XMLStreamException

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

doWriteAttr	back to summary
protected final void doWriteAttr(String localName, String nsURI, String prefix, char[] buf, int start, int len) throws XMLStreamException

doWriteDefaultNs	back to summary
protected void doWriteDefaultNs(String nsURI) throws XMLStreamException

doWriteEndTag	back to summary
protected void doWriteEndTag(QName expName, boolean allowEmpty) throws XMLStreamException Parameters expName:QName Name that the closing element should have; null if whatever is in stack should be used allowEmpty:boolean If true, is allowed to create the empty element if the closing element was truly empty; if false, has to write the full empty element no matter what

doWriteNamespace	back to summary
protected void doWriteNamespace(String prefix, String nsURI) throws XMLStreamException

doWriteStartTag	back to summary
protected final void doWriteStartTag(String localName) throws XMLStreamException

doWriteStartTag	back to summary
protected final void doWriteStartTag(String prefix, String localName) throws XMLStreamException

getCurrentElementName	back to summary
public QName getCurrentElementName() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getCurrentElementName. Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Doc from org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Method that can be used to access name information of the innermost (top) element in the element stack. Returns:QName Name of the element at the top of the current element stack, if any. During validation calls it refers to the element being processed (start or end tag), or its parent (when processing text nodes), or null (in document prolog and epilog). Annotations @Override

getCurrentElementName

back to summary

public QName getCurrentElementName()

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getCurrentElementName.

Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName.

Doc from org.codehaus.stax2.validation.ValidationContext.getCurrentElementName.

Method that can be used to access name information of the innermost (top) element in the element stack.

Returns:QName

Name of the element at the top of the current element stack, if any. During validation calls it refers to the element being processed (start or end tag), or its parent (when processing text nodes), or null (in document prolog and epilog).

Annotations

@Override

getNamespaceContext	back to summary
public NamespaceContext getNamespaceContext() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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

getNamespaceURI	back to summary
public String getNamespaceURI(String prefix) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getNamespaceURI. Implements org.codehaus.stax2.validation.ValidationContext.getNamespaceURI. Doc from org.codehaus.stax2.validation.ValidationContext.getNamespaceURI. Method that can be called by the validator to resolve a namespace prefix of the currently active top-level element. This may be necessary for things like DTD validators (which may need to heuristically guess proper namespace URI of attributes, esp. ones with default values). Annotations @Override

getNamespaceURI

back to summary

public String getNamespaceURI(String prefix)

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getNamespaceURI.

Implements org.codehaus.stax2.validation.ValidationContext.getNamespaceURI.

Doc from org.codehaus.stax2.validation.ValidationContext.getNamespaceURI.

Method that can be called by the validator to resolve a namespace prefix of the currently active top-level element. This may be necessary for things like DTD validators (which may need to heuristically guess proper namespace URI of attributes, esp. ones with default values).

Annotations

@Override

getPrefix	back to summary
public String getPrefix(String uri) Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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

getTopElementDesc	back to summary
protected String getTopElementDesc() Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getTopElementDesc. Doc from com.ctc.wstx.sw.BaseStreamWriter.getTopElementDesc. Method needed for error message generation Annotations @Override

getTopElementDesc

back to summary

protected String getTopElementDesc()

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.getTopElementDesc.

Doc from com.ctc.wstx.sw.BaseStreamWriter.getTopElementDesc.

Method needed for error message generation

Annotations

@Override

setDefaultNamespace	back to summary
public abstract void setDefaultNamespace(String uri) throws XMLStreamException Redeclares javax.xml.stream.XMLStreamWriter.setDefaultNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 Exceptions XMLStreamException: if an error occurs

setDefaultNamespace

back to summary

public abstract void setDefaultNamespace(String uri) throws XMLStreamException

Redeclares javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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

Exceptions

XMLStreamException:: if an error occurs

setNamespaceContext	back to summary
public void setNamespaceContext(NamespaceContext ctxt) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.setNamespaceContext. Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext. Note Root namespace context works best if automatic prefix creation ("namespace/prefix repairing" in StAX lingo) is enabled. Parameters ctxt:NamespaceContext Doc from javax.xml.stream.XMLStreamWriter.setNamespaceContext. the namespace context to use for this writer, may not be null Annotations @Override Exceptions XMLStreamException: Doc from javax.xml.stream.XMLStreamWriter.setNamespaceContext. if an error occurs

setNamespaceContext

back to summary

public void setNamespaceContext(NamespaceContext ctxt) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.setNamespaceContext.

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Note

Root namespace context works best if automatic prefix creation ("namespace/prefix repairing" in StAX lingo) is enabled.

Parameters

ctxt:NamespaceContext

Doc from javax.xml.stream.XMLStreamWriter.setNamespaceContext.

the namespace context to use for this writer, may not be null

Annotations

@Override

Exceptions

XMLStreamException:

Doc from javax.xml.stream.XMLStreamWriter.setNamespaceContext.

if an error occurs

setPrefix	back to summary
public void setPrefix(String prefix, String uri) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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

writeAttribute	back to summary
public void writeAttribute(String localName, String value) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeAttribute. Implements javax.xml.stream.XMLStreamWriter.writeAttribute. It's assumed calling this method implies caller just wants to add an attribute that does not belong to any namespace; as such no namespace checking or prefix generation is needed. Parameters localName:String Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. the local name of the attribute value:String Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. the value of the attribute Annotations @Override Exceptions XMLStreamException: Doc from javax.xml.stream.XMLStreamWriter.writeAttribute. if an error occurs

writeAttribute

back to summary

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

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeAttribute.

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

It's assumed calling this method implies caller just wants to add an attribute that does not belong to any namespace; as such no namespace checking or prefix generation is needed.

Parameters

localName:String

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

the local name of the attribute

value:String

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

the value of the attribute

Annotations

@Override

Exceptions

XMLStreamException:

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

if an error occurs

writeAttribute	back to summary
public abstract void writeAttribute(String nsURI, String localName, String value) throws XMLStreamException Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract void writeAttribute(String nsURI, String localName, String value) throws XMLStreamException

Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute.

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract void writeAttribute(String prefix, String nsURI, String localName, String value) throws XMLStreamException Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract void writeAttribute(String prefix, String nsURI, String localName, String value) throws XMLStreamException

Redeclares javax.xml.stream.XMLStreamWriter.writeAttribute.

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract void writeDefaultNamespace(String nsURI) throws XMLStreamException Redeclares javax.xml.stream.XMLStreamWriter.writeDefaultNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 Exceptions XMLStreamException: if an error occurs

writeDefaultNamespace

back to summary

public abstract void writeDefaultNamespace(String nsURI) throws XMLStreamException

Redeclares javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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

Exceptions

XMLStreamException:: if an error occurs

writeEmptyElement	back to summary
public void writeEmptyElement(String localName) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Note It is assumed caller just wants the element to belong to whatever is the current default namespace. Parameters localName:String Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. if an error occurs

writeEmptyElement

back to summary

public void writeEmptyElement(String localName) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Note

It is assumed caller just wants the element to belong to whatever is the current default namespace.

Parameters

localName:String

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

local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:

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

if an error occurs

writeEmptyElement	back to summary
public void writeEmptyElement(String nsURI, String localName) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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 com.ctc.wstx.sw.BaseStreamWriter.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

writeEndElement	back to summary
public void writeEndElement() throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 Exceptions XMLStreamException: if an error occurs

writeEndElement

back to summary

public void writeEndElement() throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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

Exceptions

XMLStreamException:: if an error occurs

writeEndElement back to summary

writeEndElement	back to summary
public void writeEndElement(QName name) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEndElement. Method called by `javax.xml.stream.XMLEventWriter` implementation (instead of the version that takes no argument), so that we can verify it does match the start element, if necessary Annotations @Override

public void writeEndElement(QName name) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeEndElement.

Method called by javax.xml.stream.XMLEventWriter implementation (instead of the version that takes no argument), so that we can verify it does match the start element, if necessary

Annotations

@Override

writeFullEndElement back to summary

writeFullEndElement	back to summary
public void writeFullEndElement() throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeFullEndElement. Implements org.codehaus.stax2.XMLStreamWriter2.writeFullEndElement. Similar to `writeEndElement`, but never allows implicit creation of empty elements. Annotations @Override

public void writeFullEndElement() throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeFullEndElement.

Implements org.codehaus.stax2.XMLStreamWriter2.writeFullEndElement.

Similar to writeEndElement, but never allows implicit creation of empty elements.

Annotations

@Override

writeNamespace	back to summary
public abstract void writeNamespace(String prefix, String nsURI) throws XMLStreamException Redeclares javax.xml.stream.XMLStreamWriter.writeNamespace. Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract void writeNamespace(String prefix, String nsURI) throws XMLStreamException

Redeclares javax.xml.stream.XMLStreamWriter.writeNamespace.

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. This method is assumed to just use default namespace (if any), and no further checks should be done. Parameters localName:String Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. local name of the tag, may not be null Annotations @Override Exceptions XMLStreamException: Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. if an error occurs

writeStartElement

back to summary

public void writeStartElement(String localName) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement.

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

This method is assumed to just use default namespace (if any), and no further checks should be done.

Parameters

localName:String

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

local name of the tag, may not be null

Annotations

@Override

Exceptions

XMLStreamException:

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

if an error occurs

writeStartElement	back to summary
public void writeStartElement(String nsURI, String localName) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. 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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement.

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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. 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 abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement.

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

writeStartElement	back to summary
public abstract void writeStartElement(StartElement elem) throws XMLStreamException Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Doc from com.ctc.wstx.sw.BaseStreamWriter.writeStartElement. Convenience method needed by `javax.xml.stream.XMLEventWriter` implementation, to use when writing a start element, and possibly its attributes and namespace declarations. Annotations @Override

public abstract void writeStartElement(StartElement elem) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.BaseStreamWriter.writeStartElement.

Doc from com.ctc.wstx.sw.BaseStreamWriter.writeStartElement.

Convenience method needed by javax.xml.stream.XMLEventWriter implementation, to use when writing a start element, and possibly its attributes and namespace declarations.

Annotations

@Override

writeStartOrEmpty	back to summary
protected abstract void writeStartOrEmpty(String localName, String nsURI) throws XMLStreamException

writeStartOrEmpty	back to summary
protected abstract void writeStartOrEmpty(String prefix, String localName, String nsURI) throws XMLStreamException

writeTypedAttribute	back to summary
protected void writeTypedAttribute(String prefix, String nsURI, String localName, AsciiValueEncoder enc) throws XMLStreamException Implements abstract com.ctc.wstx.sw.TypedStreamWriter.writeTypedAttribute. Doc from com.ctc.wstx.sw.TypedStreamWriter.writeTypedAttribute. Method that will write attribute with value that is known not to require additional escaping. Annotations @Override

writeTypedAttribute

back to summary

protected void writeTypedAttribute(String prefix, String nsURI, String localName, AsciiValueEncoder enc) throws XMLStreamException

Implements abstract com.ctc.wstx.sw.TypedStreamWriter.writeTypedAttribute.

Doc from com.ctc.wstx.sw.TypedStreamWriter.writeTypedAttribute.

Method that will write attribute with value that is known not to require additional escaping.

Annotations

@Override

public abstract Class BaseNsStreamWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail