org.springframework.util.xml

Class StaxResult

java.lang.Object

javax.xml.transform.sax.SAXResult

org.springframework.util.xml.StaxResult

All Implemented Interfaces:

javax.xml.transform.Result

class StaxResult
extends javax.xml.transform.sax.SAXResult

Implementation of the Result tagging interface for StAX writers. Can be constructed with an XMLEventConsumer or an XMLStreamWriter.

This class is necessary because there is no implementation of Source for StaxReaders in JAXP 1.3. There is a StAXResult in JAXP 1.4 (JDK 1.6), but this class is kept around for backwards compatibility reasons.

Even though StaxResult extends from SAXResult, calling the methods of SAXResult is not supported. In general, the only supported operation on this class is to use the ContentHandler obtained via SAXResult.getHandler() to parse an input source using an XMLReader. Calling setHandler(org.xml.sax.ContentHandler) or setLexicalHandler(org.xml.sax.ext.LexicalHandler) will result in UnsupportedOperationExceptions.

Since:

3.0

Author:

Arjen Poutsma

See Also:

XMLEventWriter, XMLStreamWriter, Transformer

Field Summary

Fields

Modifier and Type	Field and Description
private javax.xml.stream.XMLEventWriter	eventWriter
private javax.xml.stream.XMLStreamWriter	streamWriter

Fields inherited from class javax.xml.transform.sax.SAXResult

FEATURE

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
StaxResult(javax.xml.stream.XMLEventWriter eventWriter) Construct a new instance of the StaxResult with the specified XMLEventWriter.
StaxResult(javax.xml.stream.XMLStreamWriter streamWriter) Construct a new instance of the StaxResult with the specified XMLStreamWriter.

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.XMLEventWriter	getXMLEventWriter() Return the XMLEventWriter used by this StaxResult.
javax.xml.stream.XMLStreamWriter	getXMLStreamWriter() Return the XMLStreamWriter used by this StaxResult.
void	setHandler(org.xml.sax.ContentHandler handler) Throws an UnsupportedOperationException.
void	setLexicalHandler(org.xml.sax.ext.LexicalHandler handler) Throws an UnsupportedOperationException.

Methods inherited from class javax.xml.transform.sax.SAXResult

getHandler, getLexicalHandler, getSystemId, setSystemId

Methods inherited from class java.lang.Object

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

Field Detail

eventWriter

private javax.xml.stream.XMLEventWriter eventWriter

streamWriter

private javax.xml.stream.XMLStreamWriter streamWriter

Constructor Detail

StaxResult

public StaxResult(javax.xml.stream.XMLStreamWriter streamWriter)

Construct a new instance of the StaxResult with the specified XMLStreamWriter.

Parameters:

streamWriter - the XMLStreamWriter to write to

StaxResult

public StaxResult(javax.xml.stream.XMLEventWriter eventWriter)

Construct a new instance of the StaxResult with the specified XMLEventWriter.

Parameters:

eventWriter - the XMLEventWriter to write to

Method Detail

getXMLEventWriter

public javax.xml.stream.XMLEventWriter getXMLEventWriter()

Return the XMLEventWriter used by this StaxResult. If this StaxResult was created with an XMLStreamWriter, the result will be null.

Returns:

the StAX event writer used by this result

See Also:

StaxResult(javax.xml.stream.XMLEventWriter)

getXMLStreamWriter

public javax.xml.stream.XMLStreamWriter getXMLStreamWriter()

Return the XMLStreamWriter used by this StaxResult. If this StaxResult was created with an XMLEventConsumer, the result will be null.

Returns:

the StAX stream writer used by this result

See Also:

StaxResult(javax.xml.stream.XMLStreamWriter)

setHandler

public void setHandler(org.xml.sax.ContentHandler handler)

Throws an UnsupportedOperationException.

Overrides:

setHandler in class javax.xml.transform.sax.SAXResult

Throws:

java.lang.UnsupportedOperationException - always

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)

Throws an UnsupportedOperationException.

Overrides:

setLexicalHandler in class javax.xml.transform.sax.SAXResult

Throws:

java.lang.UnsupportedOperationException - always