Package com.sun.xml.rpc.streaming

Class StAXWriter

java.lang.Object

com.sun.xml.rpc.streaming.XMLWriterBase

com.sun.xml.rpc.streaming.StAXWriter

All Implemented Interfaces:

XMLWriter

public class StAXWriter
extends XMLWriterBase

An implementation of XMLWriter that uses StAX

Constructor Summary

Constructors

Constructor	Description
StAXWriter(OutputStream out, String enc, boolean declare)
StAXWriter(OutputStream out, String enc, boolean declare, XMLStreamWriter writer)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the writer and its underlying stream.
void	endElement()	Write the end tag for the current element.
void	flush()	Flush the writer and its underlying stream.
String	getPrefix(String uri)	Return a prefix for the given URI.
PrefixFactory	getPrefixFactory()	Return the prefix factory in use by this writer.
String	getURI(String prefix)	Return the URI for a given prefix.
XMLStreamWriter	getXMLStreamWriter()	Returns the StAX XMLStreamWriter that is being used.
void	setPrefixFactory(PrefixFactory factory)	Set the prefix factory to be used by this writer.
void	startElement(String localName, String uri)	Write the start tag for an element.
void	startElement(String localName, String uri, String prefix)	Write the start tag for an element.
void	writeAttribute(String localName, String uri, String value)	Write an attribute of the current element.
void	writeAttributeUnquoted(String localName, String uri, String value)	Write an attribute (unquoted) of the current element.
void	writeChars(CDATA chars)	Write character data within an element.
void	writeChars(String chars)	Write character data within an element.
void	writeCharsUnquoted(char[] buf, int offset, int len)	If the first character of the string is an opening bracket, then this method assumes that the string is xml and it parses the string to write out the correct xml representation.
void	writeCharsUnquoted(String chars)	If the first character of the string is an opening bracket, then this method assumes that the string is xml and it parses the string to write out the correct xml representation.
void	writeComment(String comment)	Write a comment within an element.
void	writeNamespaceDeclaration(String uri)	Write a namespace declaration of the current element.
void	writeNamespaceDeclaration(String prefix, String uri)	Write a namespace declaration of the current element.

Methods inherited from class com.sun.xml.rpc.streaming.XMLWriterBase

startElement, startElement, startElement, writeAttribute, writeAttribute, writeAttributeUnquoted, writeAttributeUnquoted

Methods inherited from class java.lang.Object

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

Constructor Detail

StAXWriter

public StAXWriter(OutputStream out,
                  String enc,
                  boolean declare)

StAXWriter

public StAXWriter(OutputStream out,
                  String enc,
                  boolean declare,
                  XMLStreamWriter writer)

Method Detail

getXMLStreamWriter

public XMLStreamWriter getXMLStreamWriter()

Returns the StAX XMLStreamWriter that is being used.

startElement

public void startElement(String localName,
                         String uri)

Description copied from interface: XMLWriter

Write the start tag for an element.

startElement

public void startElement(String localName,
                         String uri,
                         String prefix)

Description copied from interface: XMLWriter

Write the start tag for an element.

writeAttribute

public void writeAttribute(String localName,
                           String uri,
                           String value)

Description copied from interface: XMLWriter

Write an attribute of the current element.

writeAttributeUnquoted

public void writeAttributeUnquoted(String localName,
                                   String uri,
                                   String value)

Description copied from interface: XMLWriter

Write an attribute (unquoted) of the current element.

writeChars

public void writeChars(String chars)

Description copied from interface: XMLWriter

Write character data within an element.

Specified by:

writeChars in interface XMLWriter

Specified by:

writeChars in class XMLWriterBase

writeChars

public void writeChars(CDATA chars)

Description copied from interface: XMLWriter

Write character data within an element.

Specified by:

writeChars in interface XMLWriter

Specified by:

writeChars in class XMLWriterBase

writeCharsUnquoted

public void writeCharsUnquoted(String chars)

If the first character of the string is an opening bracket, then this method assumes that the string is xml and it parses the string to write out the correct xml representation. This is because there is no api in stax to write unescaped characters.

writeCharsUnquoted

public void writeCharsUnquoted(char[] buf,
                               int offset,
                               int len)

If the first character of the string is an opening bracket, then this method assumes that the string is xml and it parses the string to write out the correct xml representation. This is because there is no api in stax to write unescaped characters.

writeComment

public void writeComment(String comment)

Description copied from interface: XMLWriter

Write a comment within an element.

Specified by:

writeComment in interface XMLWriter

Overrides:

writeComment in class XMLWriterBase

writeNamespaceDeclaration

public void writeNamespaceDeclaration(String prefix,
                                      String uri)

Description copied from interface: XMLWriter

Write a namespace declaration of the current element.

writeNamespaceDeclaration

public void writeNamespaceDeclaration(String uri)

Description copied from interface: XMLWriter

Write a namespace declaration of the current element. The prefix name will be generated by the PrefixFactory currently configured for this writer.

endElement

public void endElement()

Description copied from interface: XMLWriter

Write the end tag for the current element.

close

public void close()

Description copied from interface: XMLWriter

Close the writer and its underlying stream.

flush

public void flush()

Description copied from interface: XMLWriter

Flush the writer and its underlying stream.

getPrefix

public String getPrefix(String uri)

Description copied from interface: XMLWriter

Return a prefix for the given URI.

If no prefix for the given URI is in scope, return null.

getURI

public String getURI(String prefix)

Description copied from interface: XMLWriter

Return the URI for a given prefix. If the prefix is undeclared, return null.

getPrefixFactory

public PrefixFactory getPrefixFactory()

Description copied from interface: XMLWriter

Return the prefix factory in use by this writer.

setPrefixFactory

public void setPrefixFactory(PrefixFactory factory)

Description copied from interface: XMLWriter

Set the prefix factory to be used by this writer.