Class XMLWriterBase

java.lang.Object

com.bea.xml.stream.ReaderToWriter

com.bea.xml.stream.XMLWriterBase

All Implemented Interfaces:

XMLStreamWriter

Direct Known Subclasses:

XMLStreamRecorder

public class XMLWriterBase
extends ReaderToWriter
implements XMLStreamWriter

The base output class.

Field Summary

Fields

Modifier and Type	Field	Description
protected NamespaceContextImpl	context
protected static final String	DEFAULTNS

Constructor Summary

Constructors

Constructor	Description
XMLWriterBase()
XMLWriterBase(Writer writer)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this writer and free any resources associated with the writer.
protected void	closeEndTag()
protected void	closeStartElement()
protected void	closeStartTag()
void	flush()	Write any cached data to the underlying output mechanism.
NamespaceContext	getNamespaceContext()	Returns the current namespace context.
String	getPrefix(String uri)	Gets the prefix the uri is bound to
Object	getProperty(String name)	Get the value of a feature/property from the underlying implementation
protected String	getURIInternal(String prefix)
protected boolean	isOpen()
static void	main(String[] args)
protected void	openEndTag()
protected void	openStartTag()
void	setConfigurationContext(ConfigurationContextBase c)
void	setDefaultNamespace(String uri)	Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
void	setNamespaceContext(NamespaceContext context)	Sets the current namespace context for prefix and uri bindings.
void	setPrefix(String prefix, String uri)	Sets the prefix the uri is bound to.
void	setWriter(Writer writer)
protected void	write(char c)
protected void	write(char[] c)
protected void	write(char[] c, int start, int len)
protected void	write(String s)
void	writeAttribute(String localName, String value)	Writes an attribute to the output stream without a prefix.
void	writeAttribute(String namespaceURI, String localName, String value)	Writes an attribute to the output stream
void	writeAttribute(String prefix, String namespaceURI, String localName, String value)	Writes an attribute to the output stream
void	writeCData(String data)	Writes a CData section
void	writeCharacters(char[] text, int start, int len)	Write text to the output
void	writeCharacters(String text)	Write text to the output
protected void	writeCharactersInternal(char[] characters, int start, int length, boolean isAttributeValue)
void	writeComment(String data)	Writes an xml comment with the data enclosed
void	writeDefaultNamespace(String namespaceURI)	Writes the default namespace to the stream
void	writeDTD(String dtd)	Write a DTD section.
void	writeEmptyElement(String localName)	Writes an empty element tag to the output
void	writeEmptyElement(String namespaceURI, String localName)	Writes an empty element tag to the output
void	writeEmptyElement(String prefix, String localName, String namespaceURI)	Writes an empty element tag to the output
void	writeEndDocument()	Closes any start tags and writes corresponding end tags.
void	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.
void	writeEntityRef(String name)	Writes an entity reference
protected String	writeName(String prefix, String namespaceURI, String localName)
void	writeNamespace(String prefix, String namespaceURI)	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
void	writeProcessingInstruction(String target)	Writes a processing instruction
void	writeProcessingInstruction(String target, String text)	Writes a processing instruction
void	writeRaw(String data)
void	writeStartDocument()	Write the XML Declaration.
void	writeStartDocument(String version)	Write the XML Declaration.
void	writeStartDocument(String encoding, String version)	Write the XML Declaration.
void	writeStartElement(String localName)	Writes a start tag to the output.
void	writeStartElement(String namespaceURI, String localName)	Writes a start tag to the output
void	writeStartElement(String prefix, String localName, String namespaceURI)	Writes a start tag to the output
protected void	writeStartElementInternal(String namespaceURI, String localName)

Methods inherited from class ReaderToWriter

setStreamWriter, write, writeAll

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULTNS

protected static final String DEFAULTNS

See Also:

• Constant Field Values

context

protected NamespaceContextImpl context

Constructor Details

XMLWriterBase

public XMLWriterBase()

XMLWriterBase

public XMLWriterBase(Writer writer)

Method Details

setWriter

public void setWriter(Writer writer)

setConfigurationContext

public void setConfigurationContext(ConfigurationContextBase c)

write

protected void write(String s)
              throws XMLStreamException

Throws:

XMLStreamException

write

protected void write(char c)
              throws XMLStreamException

Throws:

XMLStreamException

write

protected void write(char[] c)
              throws XMLStreamException

Throws:

XMLStreamException

write

protected void write(char[] c,
 int start,
 int len)
              throws XMLStreamException

Throws:

XMLStreamException

writeCharactersInternal

protected void writeCharactersInternal(char[] characters,
 int start,
 int length,
 boolean isAttributeValue)
                                throws XMLStreamException

Throws:

XMLStreamException

closeStartElement

protected void closeStartElement()
                          throws XMLStreamException

Throws:

XMLStreamException

isOpen

protected boolean isOpen()

closeStartTag

protected void closeStartTag()
                      throws XMLStreamException

Throws:

XMLStreamException

writeName

protected String writeName(String prefix,
 String namespaceURI,
 String localName)
                    throws XMLStreamException

Throws:

XMLStreamException

getURIInternal

protected String getURIInternal(String prefix)

openStartTag

protected void openStartTag()
                     throws XMLStreamException

Throws:

XMLStreamException

writeStartElementInternal

protected void writeStartElementInternal(String namespaceURI,
 String localName)
                                  throws XMLStreamException

Throws:

XMLStreamException

writeStartElement

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes a start tag to the output

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

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

localName - local name of the tag, may not be null

Throws:

XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeStartElement

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes a start tag to the output

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

prefix - the prefix of the tag, may not be null

localName - local name of the tag, may not be null

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

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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.

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

localName - local name of the tag, may not be null

Throws:

XMLStreamException

writeEmptyElement

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an empty element tag to the output

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

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

localName - local name of the tag, may not be null

Throws:

XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeEmptyElement

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an empty element tag to the output

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

prefix - the prefix of the tag, may not be null

localName - local name of the tag, may not be null

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

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an empty element tag to the output

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

localName - local name of the tag, may not be null

Throws:

XMLStreamException

openEndTag

protected void openEndTag()
                   throws XMLStreamException

Throws:

XMLStreamException

closeEndTag

protected void closeEndTag()
                    throws XMLStreamException

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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.

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeRaw

public void writeRaw(String data)
              throws XMLStreamException

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

flush

public void flush()
           throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Write any cached data to the underlying output mechanism.

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Closes any start tags and writes corresponding end tags.

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an attribute to the output stream without a prefix.

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

localName - the local name of the attribute

value - the value of the attribute

Throws:

XMLStreamException

writeAttribute

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an attribute to the output stream

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

namespaceURI - the uri of the prefix for this attribute

localName - the local name of the attribute

value - the value of the attribute

Throws:

XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeAttribute

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an attribute to the output stream

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

prefix - the prefix for this attribute

namespaceURI - the uri of the prefix for this attribute

localName - the local name of the attribute

value - the value of the attribute

Throws:

XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeNamespace

public void writeNamespace(String prefix,
 String namespaceURI)
                    throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

writeNamespace in interface XMLStreamWriter

Parameters:

prefix - the prefix to bind this namespace to

namespaceURI - the uri to bind the prefix to

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes the default namespace to the stream

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Parameters:

namespaceURI - the uri to bind the default namespace to

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an xml comment with the data enclosed

Specified by:

writeComment in interface XMLStreamWriter

Parameters:

data - the data contained in the comment, may be null

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes a processing instruction

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Parameters:

target - the target of the processing instruction, may not be null

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
 String text)
                                throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes a processing instruction

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Parameters:

target - the target of the processing instruction, may not be null

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

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

writeDTD in interface XMLStreamWriter

Parameters:

dtd - the DTD to be written

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes a CData section

Specified by:

writeCData in interface XMLStreamWriter

Parameters:

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

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Writes an entity reference

Specified by:

writeEntityRef in interface XMLStreamWriter

Parameters:

name - the name of the entity

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Write the XML Declaration. Defaults the XML version to 1.0

Specified by:

writeStartDocument in interface XMLStreamWriter

Parameters:

version - version of the xml document

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String encoding,
 String version)
                        throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

writeStartDocument in interface XMLStreamWriter

Parameters:

encoding - encoding of the xml declaration

version - version of the xml document

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Write text to the output

Specified by:

writeCharacters in interface XMLStreamWriter

Parameters:

text - the value to write

Throws:

XMLStreamException

writeCharacters

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

Description copied from interface: javax.xml.stream.XMLStreamWriter

Write text to the output

Specified by:

writeCharacters in interface XMLStreamWriter

Parameters:

text - the value to write

start - the starting position in the array

len - the number of characters to write

Throws:

XMLStreamException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

Gets the prefix the uri is bound to

Specified by:

getPrefix in interface XMLStreamWriter

Returns:

the prefix or null

Throws:

XMLStreamException

setPrefix

public void setPrefix(String prefix,
 String uri)
               throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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.

Specified by:

setPrefix in interface XMLStreamWriter

Parameters:

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

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

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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.

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Parameters:

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

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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.

Specified by:

setNamespaceContext in interface XMLStreamWriter

Parameters:

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

Throws:

XMLStreamException

getNamespaceContext

public NamespaceContext getNamespaceContext()

Description copied from interface: javax.xml.stream.XMLStreamWriter

Returns the current namespace context.

Specified by:

getNamespaceContext in interface XMLStreamWriter

Returns:

the current NamespaceContext

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Description copied from interface: javax.xml.stream.XMLStreamWriter

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

Specified by:

getProperty in interface XMLStreamWriter

Parameters:

name - The name of the property, may not be null

Returns:

The value of the property

Throws:

IllegalArgumentException - if the property is not supported

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception