public class XMLWriterBase extends ReaderToWriter implements javax.xml.stream.XMLStreamWriter
The base output class.
| Modifier and Type | Field and Description |
|---|---|
protected NamespaceContextImpl |
context |
protected static java.lang.String |
DEFAULTNS |
| Constructor and Description |
|---|
XMLWriterBase() |
XMLWriterBase(java.io.Writer writer) |
| Modifier and Type | Method and 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.
|
javax.xml.namespace.NamespaceContext |
getNamespaceContext()
Returns the current namespace context.
|
java.lang.String |
getPrefix(java.lang.String uri)
Gets the prefix the uri is bound to
|
java.lang.Object |
getProperty(java.lang.String name)
Get the value of a feature/property from the underlying implementation
|
protected java.lang.String |
getURIInternal(java.lang.String prefix) |
protected boolean |
isOpen() |
static void |
main(java.lang.String[] args) |
protected void |
openEndTag() |
protected void |
openStartTag() |
void |
setConfigurationContext(ConfigurationContextBase c) |
void |
setDefaultNamespace(java.lang.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(javax.xml.namespace.NamespaceContext context)
Sets the current namespace context for prefix and uri bindings.
|
void |
setPrefix(java.lang.String prefix,
java.lang.String uri)
Sets the prefix the uri is bound to.
|
void |
setWriter(java.io.Writer writer) |
protected void |
write(char c) |
protected void |
write(char[] c) |
protected void |
write(char[] c,
int start,
int len) |
protected void |
write(java.lang.String s) |
void |
writeAttribute(java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream without
a prefix.
|
void |
writeAttribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream
|
void |
writeAttribute(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream
|
void |
writeCData(java.lang.String data)
Writes a CData section
|
void |
writeCharacters(char[] text,
int start,
int len)
Write text to the output
|
void |
writeCharacters(java.lang.String text)
Write text to the output
|
protected void |
writeCharactersInternal(char[] characters,
int start,
int length,
boolean isAttributeValue) |
void |
writeComment(java.lang.String data)
Writes an xml comment with the data enclosed
|
void |
writeDefaultNamespace(java.lang.String namespaceURI)
Writes the default namespace to the stream
|
void |
writeDTD(java.lang.String dtd)
Write a DTD section.
|
void |
writeEmptyElement(java.lang.String localName)
Writes an empty element tag to the output
|
void |
writeEmptyElement(java.lang.String namespaceURI,
java.lang.String localName)
Writes an empty element tag to the output
|
void |
writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.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(java.lang.String name)
Writes an entity reference
|
protected java.lang.String |
writeName(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName) |
void |
writeNamespace(java.lang.String prefix,
java.lang.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(java.lang.String target)
Writes a processing instruction
|
void |
writeProcessingInstruction(java.lang.String target,
java.lang.String text)
Writes a processing instruction
|
void |
writeRaw(java.lang.String data) |
void |
writeStartDocument()
Write the XML Declaration.
|
void |
writeStartDocument(java.lang.String version)
Write the XML Declaration.
|
void |
writeStartDocument(java.lang.String encoding,
java.lang.String version)
Write the XML Declaration.
|
void |
writeStartElement(java.lang.String localName)
Writes a start tag to the output.
|
void |
writeStartElement(java.lang.String namespaceURI,
java.lang.String localName)
Writes a start tag to the output
|
void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
Writes a start tag to the output
|
protected void |
writeStartElementInternal(java.lang.String namespaceURI,
java.lang.String localName) |
setStreamWriter, write, writeAllprotected static final java.lang.String DEFAULTNS
protected NamespaceContextImpl context
public XMLWriterBase()
public XMLWriterBase(java.io.Writer writer)
public void setWriter(java.io.Writer writer)
public void setConfigurationContext(ConfigurationContextBase c)
protected void write(java.lang.String s)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void write(char c)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void write(char[] c)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void write(char[] c,
int start,
int len)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void writeCharactersInternal(char[] characters,
int start,
int length,
boolean isAttributeValue)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void closeStartElement()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected boolean isOpen()
protected void closeStartTag()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected java.lang.String writeName(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected java.lang.String getURIInternal(java.lang.String prefix)
protected void openStartTag()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void writeStartElementInternal(java.lang.String namespaceURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void writeStartElement(java.lang.String namespaceURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartElement in interface javax.xml.stream.XMLStreamWriternamespaceURI - the namespaceURI of the prefix to use, may not be nulllocalName - local name of the tag, may not be nulljavax.xml.stream.XMLStreamException - if the namespace URI has not been bound to a prefix and
javax.xml.stream.isPrefixDefaulting has not been set to truepublic void writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartElement in interface javax.xml.stream.XMLStreamWriterprefix - the prefix of the tag, may not be nulllocalName - local name of the tag, may not be nullnamespaceURI - the uri to bind the prefix to, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeStartElement(java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartElement in interface javax.xml.stream.XMLStreamWriterlocalName - local name of the tag, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeEmptyElement(java.lang.String namespaceURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEmptyElement in interface javax.xml.stream.XMLStreamWriternamespaceURI - the uri to bind the tag to, may not be nulllocalName - local name of the tag, may not be nulljavax.xml.stream.XMLStreamException - if the namespace URI has not been bound to a prefix and
javax.xml.stream.isPrefixDefaulting has not been set to truepublic void writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEmptyElement in interface javax.xml.stream.XMLStreamWriterprefix - the prefix of the tag, may not be nulllocalName - local name of the tag, may not be nullnamespaceURI - the uri to bind the tag to, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeEmptyElement(java.lang.String localName)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEmptyElement in interface javax.xml.stream.XMLStreamWriterlocalName - local name of the tag, may not be nulljavax.xml.stream.XMLStreamExceptionprotected void openEndTag()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void closeEndTag()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void writeEndElement()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEndElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeRaw(java.lang.String data)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void close()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterclose in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void flush()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterflush in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEndDocument()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEndDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeAttribute(java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteAttribute in interface javax.xml.stream.XMLStreamWriterlocalName - the local name of the attributevalue - the value of the attributejavax.xml.stream.XMLStreamExceptionpublic void writeAttribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteAttribute in interface javax.xml.stream.XMLStreamWriternamespaceURI - the uri of the prefix for this attributelocalName - the local name of the attributevalue - the value of the attributejavax.xml.stream.XMLStreamException - if the namespace URI has not been bound to a prefix and
javax.xml.stream.isPrefixDefaulting has not been set to truepublic void writeAttribute(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteAttribute in interface javax.xml.stream.XMLStreamWriterprefix - the prefix for this attributenamespaceURI - the uri of the prefix for this attributelocalName - the local name of the attributevalue - the value of the attributejavax.xml.stream.XMLStreamException - if the namespace URI has not been bound to a prefix and
javax.xml.stream.isPrefixDefaulting has not been set to truepublic void writeNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteNamespace in interface javax.xml.stream.XMLStreamWriterprefix - the prefix to bind this namespace tonamespaceURI - the uri to bind the prefix tojavax.xml.stream.XMLStreamExceptionpublic void writeDefaultNamespace(java.lang.String namespaceURI)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteDefaultNamespace in interface javax.xml.stream.XMLStreamWriternamespaceURI - the uri to bind the default namespace tojavax.xml.stream.XMLStreamExceptionpublic void writeComment(java.lang.String data)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteComment in interface javax.xml.stream.XMLStreamWriterdata - the data contained in the comment, may be nulljavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(java.lang.String target)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteProcessingInstruction in interface javax.xml.stream.XMLStreamWritertarget - the target of the processing instruction, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(java.lang.String target,
java.lang.String text)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteProcessingInstruction in interface javax.xml.stream.XMLStreamWritertarget - the target of the processing instruction, may not be nulltext - the data contained in the processing instruction, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeDTD(java.lang.String dtd)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteDTD in interface javax.xml.stream.XMLStreamWriterdtd - the DTD to be writtenjavax.xml.stream.XMLStreamExceptionpublic void writeCData(java.lang.String data)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteCData in interface javax.xml.stream.XMLStreamWriterdata - the data contained in the CData Section, may not be nulljavax.xml.stream.XMLStreamExceptionpublic void writeEntityRef(java.lang.String name)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteEntityRef in interface javax.xml.stream.XMLStreamWritername - the name of the entityjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(java.lang.String version)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartDocument in interface javax.xml.stream.XMLStreamWriterversion - version of the xml documentjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(java.lang.String encoding,
java.lang.String version)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteStartDocument in interface javax.xml.stream.XMLStreamWriterencoding - encoding of the xml declarationversion - version of the xml documentjavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(java.lang.String text)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteCharacters in interface javax.xml.stream.XMLStreamWritertext - the value to writejavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(char[] text,
int start,
int len)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWriterwriteCharacters in interface javax.xml.stream.XMLStreamWritertext - the value to writestart - the starting position in the arraylen - the number of characters to writejavax.xml.stream.XMLStreamExceptionpublic java.lang.String getPrefix(java.lang.String uri)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWritergetPrefix in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void setPrefix(java.lang.String prefix,
java.lang.String uri)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWritersetPrefix in interface javax.xml.stream.XMLStreamWriterprefix - the prefix to bind to the uri, may not be nulluri - the uri to bind to the prefix, may be nulljavax.xml.stream.XMLStreamExceptionpublic void setDefaultNamespace(java.lang.String uri)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWritersetDefaultNamespace in interface javax.xml.stream.XMLStreamWriteruri - the uri to bind to the default namespace, may be nulljavax.xml.stream.XMLStreamExceptionpublic void setNamespaceContext(javax.xml.namespace.NamespaceContext context)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamWritersetNamespaceContext in interface javax.xml.stream.XMLStreamWritercontext - the namespace context to use for this writer, may not be nulljavax.xml.stream.XMLStreamExceptionpublic javax.xml.namespace.NamespaceContext getNamespaceContext()
javax.xml.stream.XMLStreamWritergetNamespaceContext in interface javax.xml.stream.XMLStreamWriterpublic java.lang.Object getProperty(java.lang.String name)
throws java.lang.IllegalArgumentException
javax.xml.stream.XMLStreamWritergetProperty in interface javax.xml.stream.XMLStreamWritername - The name of the property, may not be nulljava.lang.IllegalArgumentException - if the property is not supportedpublic static void main(java.lang.String[] args)
throws java.lang.Exception
java.lang.Exception