Top Description Fields Constructors Methods
org.codehaus.stax2.util

public Class StreamWriterDelegate

extends Object
implements XMLStreamWriter
Class Inheritance
All Implemented Interfaces
javax.xml.stream.XMLStreamWriter
Known Direct Subclasses
org.codehaus.stax2.ri.Stax2WriterAdapter, org.codehaus.stax2.util.StreamWriter2Delegate
Imports
javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamException, .XMLStreamWriter
Similar to javax.xml.stream.util.StreamReaderDelegate, but implements a proxy for XMLStreamWriter. The only additional methods are ones for setting and accessing the delegate to forward requests to.

Note

such class really should exist in core Stax API (in package javax.xml.stream.util), but since it does not, it is implemented within Stax2 extension API

Since
3.0

Field Summary

Modifier and TypeField and Description
protected XMLStreamWriter
mDelegate

Constructor Summary

AccessConstructor and Description
public
StreamWriterDelegate(XMLStreamWriter parentWriter)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements javax.xml.stream.XMLStreamWriter.close.

Close this writer and free any resources associated with the writer.
public void
flush()

Implements javax.xml.stream.XMLStreamWriter.flush.

Write any cached data to the underlying output mechanism.
public NamespaceContext
getNamespaceContext()

Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Returns the current namespace context.
public XMLStreamWriter
getParent()

public String
getPrefix(String
the uri the prefix is bound to
ns)

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
pname)

Implements javax.xml.stream.XMLStreamWriter.getProperty.

Get the value of a feature/property from the underlying implementation
public void
setDefaultNamespace(String
the uri to bind to the default namespace, may be null
ns)

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
setNamespaceContext(NamespaceContext
the namespace context to use for this writer, may not be null
nc)

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Sets the current namespace context for prefix and uri bindings.
public void
setParent(XMLStreamWriter parentWriter)

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 javax.xml.stream.XMLStreamWriter.setPrefix.

Sets the prefix the uri is bound to.
public void
writeAttribute(String
the local name of the attribute
arg0, String
the value of the attribute
arg1)

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
arg0, String
the local name of the attribute
arg1, String
the value of the attribute
arg2)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream
public void
writeAttribute(String
the prefix for this attribute
arg0, String
the uri of the prefix for this attribute
arg1, String
the local name of the attribute
arg2, String
the value of the attribute
arg3)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream
public void
writeCData(String
the data contained in the CData Section, may not be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeCData.

Writes a CData section
public void
writeCharacters(String
the value to write
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output
public void
writeCharacters(char[]
the value to write
arg0, int
the starting position in the array
arg1, int
the number of characters to write
arg2)

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output
public void
writeComment(String
the data contained in the comment, may be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeComment.

Writes an xml comment with the data enclosed
public void
writeDefaultNamespace(String
the uri to bind the default namespace to
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Writes the default namespace to the stream
public void
writeDTD(String
the DTD to be written
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeDTD.

Write a DTD section.
public void
writeEmptyElement(String
local name of the tag, may not be null
arg0)

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
arg0, String
local name of the tag, may not be null
arg1)

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
arg0, String
local name of the tag, may not be null
arg1, String
the uri to bind the tag to, may not be null
arg2)

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output
public void
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
writeEntityRef(String
the name of the entity
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

Writes an entity reference
public void
writeNamespace(String
the prefix to bind this namespace to
arg0, String
the uri to bind the prefix to
arg1)

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
writeProcessingInstruction(String
the target of the processing instruction, may not be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction
public void
writeProcessingInstruction(String
the target of the processing instruction, may not be null
arg0, String
the data contained in the processing instruction, may not be null
arg1)

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction
public void
writeStartDocument()

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.
public void
writeStartDocument(String
version of the xml document
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.
public void
writeStartDocument(String
encoding of the xml declaration
arg0, String
version of the xml document
arg1)

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.
public void
writeStartElement(String
local name of the tag, may not be null
arg0)

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
arg0, String
local name of the tag, may not be null
arg1)

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
arg0, String
local name of the tag, may not be null
arg1, String
the uri to bind the prefix to, may not be null
arg2)

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mDelegateback to summary
protected XMLStreamWriter mDelegate

Constructor Detail

StreamWriterDelegateback to summary
public StreamWriterDelegate(XMLStreamWriter parentWriter)

Method Detail

closeback to summary
public void close() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.close.

Doc from javax.xml.stream.XMLStreamWriter.close.

Close this writer and free any resources associated with the writer. This must not close the underlying output stream.

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
flushback to summary
public void flush() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.flush.

Doc from javax.xml.stream.XMLStreamWriter.flush.

Write any cached data to the underlying output mechanism.

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
getNamespaceContextback to summary
public NamespaceContext 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
getParentback to summary
public XMLStreamWriter getParent()
getPrefixback to summary
public String getPrefix(String ns) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

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

Gets the prefix the uri is bound to.

Parameters
ns:String

the uri the prefix is bound to

Returns:String

the prefix or null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
getPropertyback to summary
public Object getProperty(String pname) throws IllegalArgumentException

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
pname:String

The name of the property, may not be null

Returns:Object

The value of the property

Annotations
@Override
Exceptions
IllegalArgumentException:
if the property is not supported
setDefaultNamespaceback to summary
public void setDefaultNamespace(String ns) throws XMLStreamException

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
ns:String

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

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
setNamespaceContextback to summary
public void setNamespaceContext(NamespaceContext nc) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

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

Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces. This method may only be called once at the start of the document. It does not cause the namespaces to be declared. If a namespace URI to prefix mapping is found in the namespace context it is treated as declared and the prefix may be used by the StreamWriter.

Parameters
nc:NamespaceContext

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

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
setParentback to summary
public void setParent(XMLStreamWriter parentWriter)
setPrefixback to summary
public void setPrefix(String prefix, String uri) throws XMLStreamException

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
writeAttributeback to summary
public void writeAttribute(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

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

Writes an attribute to the output stream without a prefix.

Parameters
arg0:String

the local name of the attribute

arg1:String

the value of the attribute

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeAttributeback to summary
public void writeAttribute(String arg0, String arg1, String arg2) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

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

Writes an attribute to the output stream

Parameters
arg0:String

the uri of the prefix for this attribute

arg1:String

the local name of the attribute

arg2: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
writeAttributeback to summary
public void writeAttribute(String arg0, String arg1, String arg2, String arg3) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

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

Writes an attribute to the output stream

Parameters
arg0:String

the prefix for this attribute

arg1:String

the uri of the prefix for this attribute

arg2:String

the local name of the attribute

arg3: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
writeCDataback to summary
public void writeCData(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCData.

Doc from javax.xml.stream.XMLStreamWriter.writeCData.

Writes a CData section

Parameters
arg0:String

the data contained in the CData Section, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeCharactersback to summary
public void writeCharacters(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Doc from javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

Parameters
arg0:String

the value to write

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeCharactersback to summary
public void writeCharacters(char[] arg0, int arg1, int arg2) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Doc from javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

Parameters
arg0:char[]

the value to write

arg1:int

the starting position in the array

arg2:int

the number of characters to write

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeCommentback to summary
public void writeComment(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeComment.

Doc from javax.xml.stream.XMLStreamWriter.writeComment.

Writes an xml comment with the data enclosed

Parameters
arg0:String

the data contained in the comment, may be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeDefaultNamespaceback to summary
public void writeDefaultNamespace(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

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

Writes the default namespace to the stream

Parameters
arg0:String

the uri to bind the default namespace to

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeDTDback to summary
public void writeDTD(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeDTD.

Doc from javax.xml.stream.XMLStreamWriter.writeDTD.

Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.

Parameters
arg0:String

the DTD to be written

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeEmptyElementback to summary
public void writeEmptyElement(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

Parameters
arg0:String

local name of the tag, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeEmptyElementback to summary
public void writeEmptyElement(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

Parameters
arg0:String

the uri to bind the tag to, may not be null

arg1: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
writeEmptyElementback to summary
public void writeEmptyElement(String arg0, String arg1, String arg2) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

Parameters
arg0:String

the prefix of the tag, may not be null

arg1:String

local name of the tag, may not be null

arg2:String

the uri to bind the tag to, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeEndDocumentback to summary
public void writeEndDocument() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEndDocument.

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

Closes any start tags and writes corresponding end tags.

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeEndElementback to summary
public void writeEndElement() throws XMLStreamException

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
writeEntityRefback to summary
public void writeEntityRef(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

Doc from javax.xml.stream.XMLStreamWriter.writeEntityRef.

Writes an entity reference

Parameters
arg0:String

the name of the entity

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeNamespaceback to summary
public void writeNamespace(String arg0, String arg1) 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
arg0:String

the prefix to bind this namespace to

arg1:String

the uri to bind the prefix to

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Doc from javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction

Parameters
arg0:String

the target of the processing instruction, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Doc from javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction

Parameters
arg0:String

the target of the processing instruction, may not be null

arg1:String

the data contained in the processing instruction, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Defaults the XML version to 1.0

Parameters
arg0:String

version of the xml document

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory

Parameters
arg0:String

encoding of the xml declaration

arg1:String

version of the xml document

Annotations
@Override
Exceptions
XMLStreamException:
If given encoding does not match encoding of the underlying stream
writeStartElementback to summary
public void writeStartElement(String arg0) 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
arg0:String

local name of the tag, may not be null

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs
writeStartElementback to summary
public void writeStartElement(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

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

Writes a start tag to the output

Parameters
arg0:String

the namespaceURI of the prefix to use, may not be null

arg1: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
writeStartElementback to summary
public void writeStartElement(String arg0, String arg1, String arg2) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

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

Writes a start tag to the output

Parameters
arg0:String

the prefix of the tag, may not be null

arg1:String

local name of the tag, may not be null

arg2:String

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

Annotations
@Override
Exceptions
XMLStreamException:
if an error occurs