nl.flotsam.pecia.builder.xml
Interface XmlWriter

All Known Implementing Classes:

LoggingXmlWriter, StreamingXmlWriter

public interface XmlWriter

Method Summary

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 XmlWriterException

Write the start of a tag.

Throws:

XmlWriterException

writeStartElement

void writeStartElement(String namespaceURI,
                       String localName)
                       throws XmlWriterException

Write the start of a tag.

Throws:

XmlWriterException

writeStartElement

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

Write the start of a tag.

Throws:

XmlWriterException

writeEmptyElement

void writeEmptyElement(String namespaceURI,
                       String localName)
                       throws XmlWriterException

Write an empty tag.

Throws:

XmlWriterException

writeEmptyElement

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

Write an empty tag.

Throws:

XmlWriterException

writeEmptyElement

void writeEmptyElement(String localName)
                       throws XmlWriterException

Write an empty tag.

Throws:

XmlWriterException

writeEndElement

void writeEndElement()
                     throws XmlWriterException

Closes the currently open tag.

Throws:

XmlWriterException

writeEndDocument

void writeEndDocument()
                      throws XmlWriterException

Closes any currently open tags.

Throws:

XmlWriterException

close

void close()
           throws XmlWriterException

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

Throws:

XmlWriterException

flush

void flush()
           throws XmlWriterException

Flushes any cached information to the underlying output sink.

Throws:

XmlWriterException

writeAttribute

void writeAttribute(String localName,
                    String value)
                    throws XmlWriterException

Write an attribute.

Throws:

XmlWriterException

writeAttribute

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

Write an attribute.

Throws:

XmlWriterException

writeAttribute

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

Write an attribute.

Throws:

XmlWriterException

writeNamespace

void writeNamespace(String prefix,
                    String namespaceURI)
                    throws XmlWriterException

Write a namespace declaration.

Throws:

XmlWriterException

writeDefaultNamespace

void writeDefaultNamespace(String namespaceURI)
                           throws XmlWriterException

Write a default namespace declaration.

Throws:

XmlWriterException

writeComment

void writeComment(String data)
                  throws XmlWriterException

Write a comment.

Throws:

XmlWriterException

writeProcessingInstruction

void writeProcessingInstruction(String target)
                                throws XmlWriterException

Write a processing instruction.

Throws:

XmlWriterException

writeProcessingInstruction

void writeProcessingInstruction(String target,
                                String data)
                                throws XmlWriterException

Write a processing instruction.

Throws:

XmlWriterException

writeCData

void writeCData(String data)
                throws XmlWriterException

Write a CDATA section.

Throws:

XmlWriterException

writeDTD

void writeDTD(String dtd)
              throws XmlWriterException

Write a DOCTYPE declaration.

Throws:

XmlWriterException

writeEntityRef

void writeEntityRef(String name)
                    throws XmlWriterException

Write an entity reference.

Throws:

XmlWriterException

writeStartDocument

void writeStartDocument()
                        throws XmlWriterException

Write an XML declaration.

Throws:

XmlWriterException

writeStartDocument

void writeStartDocument(String version)
                        throws XmlWriterException

Write an XML declaration with the specified XML version.

Throws:

XmlWriterException

writeStartDocument

void writeStartDocument(String encoding,
                        String version)
                        throws XmlWriterException

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

Throws:

XmlWriterException

writeCharacters

void writeCharacters(String text)
                     throws XmlWriterException

Write the specified text.

Throws:

XmlWriterException

writeCharacters

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

Write the specified text.

Throws:

XmlWriterException

getPrefix

String getPrefix(String uri)
                 throws XmlWriterException

Returns the prefix associated with the given namespace URI.

Throws:

XmlWriterException

setPrefix

void setPrefix(String prefix,
               String uri)
               throws XmlWriterException

Sets the prefix for the given namespace URI.

Throws:

XmlWriterException

setDefaultNamespace

void setDefaultNamespace(String uri)
                         throws XmlWriterException

Sets the URI for the default namespace.

Throws:

XmlWriterException

setNamespaceContext

void setNamespaceContext(NamespaceContext context)
                         throws XmlWriterException

Sets the namespace context for namespace resolution.

Throws:

XmlWriterException

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