Top Description Fields Constructors Methods
org.glassfish.hk2.utilities.general

pack-priv abstract Class DelegatingXMLStreamWriter

extends Object
implements XMLStreamWriter
Class Inheritance
All Implemented Interfaces
javax.xml.stream.XMLStreamWriter
Known Direct Subclasses
org.glassfish.hk2.utilities.general.IndentingXMLStreamWriter
Imports
javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamException, .XMLStreamWriter

Delegating XMLStreamWriter.
Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
private final XMLStreamWriter

Constructor Summary

AccessConstructor and Description
public

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 String
getPrefix(String uri)

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

Gets the prefix the uri is bound to.

public Object
getProperty(String name)

Implements javax.xml.stream.XMLStreamWriter.getProperty.

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

public void
setDefaultNamespace(String uri)

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

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Sets the current namespace context for prefix and uri bindings.

public void
setPrefix(String prefix, String uri)

Implements javax.xml.stream.XMLStreamWriter.setPrefix.

Sets the prefix the uri is bound to.

public void
writeAttribute(String localName, String value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream without a prefix.

public void
writeAttribute(String prefix, String namespaceURI, String localName, String value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

public void
writeAttribute(String namespaceURI, String localName, String value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

public void
writeCData(String data)

Implements javax.xml.stream.XMLStreamWriter.writeCData.

Writes a CData section

public void
public void
writeCharacters(char[] text, int start, int len)

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

public void
writeComment(String data)

Implements javax.xml.stream.XMLStreamWriter.writeComment.

Writes an xml comment with the data enclosed

public void
writeDefaultNamespace(String namespaceURI)

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Writes the default namespace to the stream

public void
writeDTD(String dtd)

Implements javax.xml.stream.XMLStreamWriter.writeDTD.

Write a DTD section.

public void
writeEmptyElement(String namespaceURI, String localName)

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

public void
writeEmptyElement(String prefix, String localName, String namespaceURI)

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

public void
writeEmptyElement(String localName)

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

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

Writes an entity reference

public void
writeNamespace(String prefix, String namespaceURI)

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
public void
public void
public void
writeStartDocument(String version)

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.

public void
writeStartDocument(String encoding, String version)

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.

public void
writeStartElement(String localName)

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output.

public void
writeStartElement(String namespaceURI, String localName)

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

public void
writeStartElement(String prefix, String localName, String namespaceURI)

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

writerback to summary
private final XMLStreamWriter writer

Constructor Detail

DelegatingXMLStreamWriterback to summary
public DelegatingXMLStreamWriter(XMLStreamWriter writer)

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.

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.

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.

getPrefixback to summary
public String getPrefix(String uri) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

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

Gets the prefix the uri is bound to.

Exceptions
XMLStreamException:
if an error occurs
getPropertyback to summary
public Object getProperty(String name) 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

Exceptions
IllegalArgumentException:
if the property is not supported
setDefaultNamespaceback to summary
public void setDefaultNamespace(String uri) 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.

Exceptions
XMLStreamException:
if an error occurs
setNamespaceContextback to summary
public void setNamespaceContext(NamespaceContext context) 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.

Exceptions
XMLStreamException:
if an error occurs
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.

Exceptions
XMLStreamException:
if an error occurs
writeAttributeback to summary
public void writeAttribute(String localName, String value) 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.

Exceptions
XMLStreamException:
if an error occurs
writeAttributeback to summary
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

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

Writes an attribute to the output stream

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 namespaceURI, String localName, String value) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

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

Writes an attribute to the output stream

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 data) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCData.

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

Writes a CData section

Exceptions
XMLStreamException:
if an error occurs
writeCharactersback to summary
public void writeCharacters(String text) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

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

Write text to the output

Exceptions
XMLStreamException:
if an error occurs
writeCharactersback to summary
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

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

Write text to the output

Exceptions
XMLStreamException:
if an error occurs
writeCommentback to summary
public void writeComment(String data) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeComment.

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

Writes an xml comment with the data enclosed

Exceptions
XMLStreamException:
if an error occurs
writeDefaultNamespaceback to summary
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

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

Writes the default namespace to the stream

Exceptions
XMLStreamException:
if an error occurs
writeDTDback to summary
public void writeDTD(String dtd) 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.

Exceptions
XMLStreamException:
if an error occurs
writeEmptyElementback to summary
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

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 prefix, String localName, String namespaceURI) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

Exceptions
XMLStreamException:
if an error occurs
writeEmptyElementback to summary
public void writeEmptyElement(String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

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

Writes an empty element tag to the output

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.

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.

Exceptions
XMLStreamException:
if an error occurs
writeEntityRefback to summary
public void writeEntityRef(String name) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

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

Writes an entity reference

Exceptions
XMLStreamException:
if an error occurs
writeNamespaceback to summary
public void writeNamespace(String prefix, String namespaceURI) 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

Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String target) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

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

Writes a processing instruction

Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String target, String data) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

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

Writes a processing instruction

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

Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument(String version) 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

Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument(String encoding, String version) 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

Exceptions
XMLStreamException:
If given encoding does not match encoding of the underlying stream
writeStartElementback 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.

Exceptions
XMLStreamException:
if an error occurs
writeStartElementback to summary
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

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

Writes a start tag to the output

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 prefix, String localName, String namespaceURI) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

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

Writes a start tag to the output

Exceptions
XMLStreamException:
if an error occurs