javax.xml.stream

Interface XMLStreamWriter

public interface XMLStreamWriter

Interface for writing XML to a stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Frees any resources used by this writer.
void	flush() Flushes any cached information to the underlying output sink.
NamespaceContext	getNamespaceContext() Returns the current namespace context.
String	getPrefix(String uri) Returns the prefix associated with the given namespace URI.
Object	getProperty(String name) Returns the implementation-specific feature or property of the given name.
void	setDefaultNamespace(String uri) Sets the URI for the default namespace.
void	setNamespaceContext(NamespaceContext context) Sets the namespace context for namespace resolution.
void	setPrefix(String prefix, String uri) Sets the prefix for the given namespace URI.
void	writeAttribute(String localName, String value) Write an attribute.
void	writeAttribute(String namespaceURI, String localName, String value) Write an attribute.
void	writeAttribute(String prefix, String namespaceURI, String localName, String value) Write an attribute.
void	writeCData(String data) Write a CDATA section.
void	writeCharacters(char[] text, int start, int len) Write the specified text.
void	writeCharacters(String text) Write the specified text.
void	writeComment(String data) Write a comment.
void	writeDefaultNamespace(String namespaceURI) Write a default namespace declaration.
void	writeDTD(String dtd) Write a DOCTYPE declaration.
void	writeEmptyElement(String localName) Write an empty tag.
void	writeEmptyElement(String namespaceURI, String localName) Write an empty tag.
void	writeEmptyElement(String prefix, String localName, String namespaceURI) Write an empty tag.
void	writeEndDocument() Closes any currently open tags.
void	writeEndElement() Closes the currently open tag.
void	writeEntityRef(String name) Write an entity reference.
void	writeNamespace(String prefix, String namespaceURI) Write a namespace declaration.
void	writeProcessingInstruction(String target) Write a processing instruction.
void	writeProcessingInstruction(String target, String data) Write a processing instruction.
void	writeStartDocument() Write an XML declaration.
void	writeStartDocument(String version) Write an XML declaration with the specified XML version.
void	writeStartDocument(String encoding, String version) Write an XML declaration with the specifed XML version and encoding.
void	writeStartElement(String localName) Write the start of a tag.
void	writeStartElement(String namespaceURI, String localName) Write the start of a tag.
void	writeStartElement(String prefix, String localName, String namespaceURI) Write the start of a tag.

Method Detail

writeStartElement

void writeStartElement(String localName)
                       throws XMLStreamException

Write the start of a tag.

Throws:

XMLStreamException

writeStartElement

void writeStartElement(String namespaceURI,
                     String localName)
                       throws XMLStreamException

Write the start of a tag.

Throws:

XMLStreamException

writeStartElement

void writeStartElement(String prefix,
                     String localName,
                     String namespaceURI)
                       throws XMLStreamException

Write the start of a tag.

Throws:

XMLStreamException

writeEmptyElement

void writeEmptyElement(String namespaceURI,
                     String localName)
                       throws XMLStreamException

Write an empty tag.

Throws:

XMLStreamException

writeEmptyElement

void writeEmptyElement(String prefix,
                     String localName,
                     String namespaceURI)
                       throws XMLStreamException

Write an empty tag.

Throws:

XMLStreamException

writeEmptyElement

void writeEmptyElement(String localName)
                       throws XMLStreamException

Write an empty tag.

Throws:

XMLStreamException

writeEndElement

void writeEndElement()
                     throws XMLStreamException

Closes the currently open tag.

Throws:

XMLStreamException

writeEndDocument

void writeEndDocument()
                      throws XMLStreamException

Closes any currently open tags.

Throws:

XMLStreamException

close

void close()
           throws XMLStreamException

Frees any resources used by this writer. This will not close the underlying output sink.

Throws:

XMLStreamException

flush

void flush()
           throws XMLStreamException

Flushes any cached information to the underlying output sink.

Throws:

XMLStreamException

writeAttribute

void writeAttribute(String localName,
                  String value)
                    throws XMLStreamException

Write an attribute.

Throws:

XMLStreamException

writeAttribute

void writeAttribute(String prefix,
                  String namespaceURI,
                  String localName,
                  String value)
                    throws XMLStreamException

Write an attribute.

Throws:

XMLStreamException

writeAttribute

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

Write an attribute.

Throws:

XMLStreamException

writeNamespace

void writeNamespace(String prefix,
                  String namespaceURI)
                    throws XMLStreamException

Write a namespace declaration.

Throws:

XMLStreamException

writeDefaultNamespace

void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Write a default namespace declaration.

Throws:

XMLStreamException

writeComment

void writeComment(String data)
                  throws XMLStreamException

Write a comment.

Throws:

XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target)
                                throws XMLStreamException

Write a processing instruction.

Throws:

XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target,
                              String data)
                                throws XMLStreamException

Write a processing instruction.

Throws:

XMLStreamException

writeCData

void writeCData(String data)
                throws XMLStreamException

Write a CDATA section.

Throws:

XMLStreamException

writeDTD

void writeDTD(String dtd)
              throws XMLStreamException

Write a DOCTYPE declaration.

Throws:

XMLStreamException

writeEntityRef

void writeEntityRef(String name)
                    throws XMLStreamException

Write an entity reference.

Throws:

XMLStreamException

writeStartDocument

void writeStartDocument()
                        throws XMLStreamException

Write an XML declaration.

Throws:

XMLStreamException

writeStartDocument

void writeStartDocument(String version)
                        throws XMLStreamException

Write an XML declaration with the specified XML version.

Throws:

XMLStreamException

writeStartDocument

void writeStartDocument(String encoding,
                      String version)
                        throws XMLStreamException

Write an XML declaration with the specifed XML version and encoding.

Throws:

XMLStreamException

writeCharacters

void writeCharacters(String text)
                     throws XMLStreamException

Write the specified text.

Throws:

XMLStreamException

writeCharacters

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

Write the specified text.

Throws:

XMLStreamException

getPrefix

String getPrefix(String uri)
                 throws XMLStreamException

Returns the prefix associated with the given namespace URI.

Throws:

XMLStreamException

setPrefix

void setPrefix(String prefix,
             String uri)
               throws XMLStreamException

Sets the prefix for the given namespace URI.

Throws:

XMLStreamException

setDefaultNamespace

void setDefaultNamespace(String uri)
                         throws XMLStreamException

Sets the URI for the default namespace.

Throws:

XMLStreamException

setNamespaceContext

void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Sets the namespace context for namespace resolution.

Throws:

XMLStreamException

getNamespaceContext

NamespaceContext getNamespaceContext()

Returns the current namespace context.

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException

Returns the implementation-specific feature or property of the given name.

Throws:

IllegalArgumentException - if the property is not supported