Package com.bea.xml.stream
Class XMLWriterBase
java.lang.Object
com.bea.xml.stream.ReaderToWriter
com.bea.xml.stream.XMLWriterBase
- All Implemented Interfaces:
XMLStreamWriter
- Direct Known Subclasses:
XMLStreamRecorder
The base output class.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close this writer and free any resources associated with the writer.protected void
protected void
protected void
void
flush()
Write any cached data to the underlying output mechanism.Returns the current namespace context.Gets the prefix the uri is bound togetProperty
(String name) Get the value of a feature/property from the underlying implementationprotected String
getURIInternal
(String prefix) protected boolean
isOpen()
static void
protected void
protected void
void
void
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
Sets the prefix the uri is bound to.void
protected void
write
(char c) protected void
write
(char[] c) protected void
write
(char[] c, int start, int len) protected void
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 streamvoid
writeAttribute
(String prefix, String namespaceURI, String localName, String value) Writes an attribute to the output streamvoid
writeCData
(String data) Writes a CData sectionvoid
writeCharacters
(char[] text, int start, int len) Write text to the outputvoid
writeCharacters
(String text) Write text to the outputprotected void
writeCharactersInternal
(char[] characters, int start, int length, boolean isAttributeValue) void
writeComment
(String data) Writes an xml comment with the data enclosedvoid
writeDefaultNamespace
(String namespaceURI) Writes the default namespace to the streamvoid
Write a DTD section.void
writeEmptyElement
(String localName) Writes an empty element tag to the outputvoid
writeEmptyElement
(String namespaceURI, String localName) Writes an empty element tag to the outputvoid
writeEmptyElement
(String prefix, String localName, String namespaceURI) Writes an empty element tag to the outputvoid
Closes any start tags and writes corresponding end tags.void
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 referenceprotected String
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 writeDefaultNamespacevoid
writeProcessingInstruction
(String target) Writes a processing instructionvoid
writeProcessingInstruction
(String target, String text) Writes a processing instructionvoid
void
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 outputvoid
writeStartElement
(String prefix, String localName, String namespaceURI) Writes a start tag to the outputprotected void
writeStartElementInternal
(String namespaceURI, String localName) Methods inherited from class com.bea.xml.stream.ReaderToWriter
setStreamWriter, write, writeAll
-
Field Details
-
DEFAULTNS
- See Also:
-
context
-
-
Constructor Details
-
XMLWriterBase
public XMLWriterBase() -
XMLWriterBase
-
-
Method Details
-
setWriter
-
setConfigurationContext
-
write
- Throws:
XMLStreamException
-
write
- Throws:
XMLStreamException
-
write
- Throws:
XMLStreamException
-
write
- Throws:
XMLStreamException
-
writeCharactersInternal
protected void writeCharactersInternal(char[] characters, int start, int length, boolean isAttributeValue) throws XMLStreamException - Throws:
XMLStreamException
-
closeStartElement
- Throws:
XMLStreamException
-
isOpen
protected boolean isOpen() -
closeStartTag
- Throws:
XMLStreamException
-
writeName
protected String writeName(String prefix, String namespaceURI, String localName) throws XMLStreamException - Throws:
XMLStreamException
-
getURIInternal
-
openStartTag
- Throws:
XMLStreamException
-
writeStartElementInternal
protected void writeStartElementInternal(String namespaceURI, String localName) throws XMLStreamException - Throws:
XMLStreamException
-
writeStartElement
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes a start tag to the output- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Parameters:
namespaceURI
- the namespaceURI of the prefix to use, may not be nulllocalName
- 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 interfaceXMLStreamWriter
- Parameters:
prefix
- 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 null- Throws:
XMLStreamException
-
writeStartElement
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 interfaceXMLStreamWriter
- Parameters:
localName
- local name of the tag, may not be null- Throws:
XMLStreamException
-
writeEmptyElement
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes an empty element tag to the output- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Parameters:
namespaceURI
- the uri to bind the tag to, may not be nulllocalName
- 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 interfaceXMLStreamWriter
- Parameters:
prefix
- 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 null- Throws:
XMLStreamException
-
writeEmptyElement
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes an empty element tag to the output- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Parameters:
localName
- local name of the tag, may not be null- Throws:
XMLStreamException
-
openEndTag
- Throws:
XMLStreamException
-
closeEndTag
- Throws:
XMLStreamException
-
writeEndElement
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 interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeRaw
- Throws:
XMLStreamException
-
close
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 interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
flush
Description copied from interface:javax.xml.stream.XMLStreamWriter
Write any cached data to the underlying output mechanism.- Specified by:
flush
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEndDocument
Description copied from interface:javax.xml.stream.XMLStreamWriter
Closes any start tags and writes corresponding end tags.- Specified by:
writeEndDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes an attribute to the output stream without a prefix.- Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Parameters:
localName
- the local name of the attributevalue
- 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 interfaceXMLStreamWriter
- Parameters:
namespaceURI
- the uri of the prefix for this attributelocalName
- the local name of the attributevalue
- 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 interfaceXMLStreamWriter
- Parameters:
prefix
- the prefix for this attributenamespaceURI
- the uri of the prefix for this attributelocalName
- the local name of the attributevalue
- 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
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 interfaceXMLStreamWriter
- Parameters:
prefix
- the prefix to bind this namespace tonamespaceURI
- the uri to bind the prefix to- Throws:
XMLStreamException
-
writeDefaultNamespace
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes the default namespace to the stream- Specified by:
writeDefaultNamespace
in interfaceXMLStreamWriter
- Parameters:
namespaceURI
- the uri to bind the default namespace to- Throws:
XMLStreamException
-
writeComment
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes an xml comment with the data enclosed- Specified by:
writeComment
in interfaceXMLStreamWriter
- Parameters:
data
- the data contained in the comment, may be null- Throws:
XMLStreamException
-
writeProcessingInstruction
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes a processing instruction- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Parameters:
target
- the target of the processing instruction, may not be null- Throws:
XMLStreamException
-
writeProcessingInstruction
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes a processing instruction- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Parameters:
target
- the target of the processing instruction, may not be nulltext
- the data contained in the processing instruction, may not be null- Throws:
XMLStreamException
-
writeDTD
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 interfaceXMLStreamWriter
- Parameters:
dtd
- the DTD to be written- Throws:
XMLStreamException
-
writeCData
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes a CData section- Specified by:
writeCData
in interfaceXMLStreamWriter
- Parameters:
data
- the data contained in the CData Section, may not be null- Throws:
XMLStreamException
-
writeEntityRef
Description copied from interface:javax.xml.stream.XMLStreamWriter
Writes an entity reference- Specified by:
writeEntityRef
in interfaceXMLStreamWriter
- Parameters:
name
- the name of the entity- Throws:
XMLStreamException
-
writeStartDocument
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 interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
Description copied from interface:javax.xml.stream.XMLStreamWriter
Write the XML Declaration. Defaults the XML version to 1.0- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Parameters:
version
- version of the xml document- Throws:
XMLStreamException
-
writeStartDocument
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 interfaceXMLStreamWriter
- Parameters:
encoding
- encoding of the xml declarationversion
- version of the xml document- Throws:
XMLStreamException
-
writeCharacters
Description copied from interface:javax.xml.stream.XMLStreamWriter
Write text to the output- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Parameters:
text
- the value to write- Throws:
XMLStreamException
-
writeCharacters
Description copied from interface:javax.xml.stream.XMLStreamWriter
Write text to the output- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Parameters:
text
- the value to writestart
- the starting position in the arraylen
- the number of characters to write- Throws:
XMLStreamException
-
getPrefix
Description copied from interface:javax.xml.stream.XMLStreamWriter
Gets the prefix the uri is bound to- Specified by:
getPrefix
in interfaceXMLStreamWriter
- Returns:
- the prefix or null
- Throws:
XMLStreamException
-
setPrefix
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 interfaceXMLStreamWriter
- Parameters:
prefix
- the prefix to bind to the uri, may not be nulluri
- the uri to bind to the prefix, may be null- Throws:
XMLStreamException
-
setDefaultNamespace
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 interfaceXMLStreamWriter
- Parameters:
uri
- the uri to bind to the default namespace, may be null- Throws:
XMLStreamException
-
setNamespaceContext
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 interfaceXMLStreamWriter
- Parameters:
context
- the namespace context to use for this writer, may not be null- Throws:
XMLStreamException
-
getNamespaceContext
Description copied from interface:javax.xml.stream.XMLStreamWriter
Returns the current namespace context.- Specified by:
getNamespaceContext
in interfaceXMLStreamWriter
- Returns:
- the current NamespaceContext
-
getProperty
Description copied from interface:javax.xml.stream.XMLStreamWriter
Get the value of a feature/property from the underlying implementation- Specified by:
getProperty
in interfaceXMLStreamWriter
- 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
- Throws:
Exception
-