org.springframework.xml.transform
Class StaxSource

java.lang.Object
  javax.xml.transform.sax.SAXSource
      org.springframework.xml.transform.StaxSource

All Implemented Interfaces:

Source

public class StaxSource
extends SAXSource

Implementation of the Source tagging interface for StAX readers. Can be constructed with a XMLEventReader or a XMLStreamReader.

This class is necessary because there is no implementation of Source for StAX Readers in JAXP 1.3. There is a StAXSource in JAXP 1.4 (JDK 1.6), but this class is kept around for back-ward compatibility reasons.

Even though StaxSource extends from SAXSource, calling the methods of SAXSource is not supported. In general, the only supported operation on this class is to use the XMLReader obtained via SAXSource.getXMLReader() to parse the input source obtained via SAXSource.getInputSource(). Calling setXMLReader(org.xml.sax.XMLReader) or setInputSource(org.xml.sax.InputSource) will result in UnsupportedOperationExceptions.

Since:

1.0.0

Author:

Arjen Poutsma

See Also:

XMLEventReader, XMLStreamReader, Transformer

Field Summary

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

FEATURE

Constructor Summary

StaxSource(XMLEventReader eventReader)
Constructs a new instance of the StaxSource with the specified XMLEventReader.

StaxSource(XMLStreamReader streamReader)
Constructs a new instance of the StaxSource with the specified XMLStreamReader.

Method Summary

XMLEventReader	getXMLEventReader() Returns the XMLEventReader used by this StaxSource.
XMLStreamReader	getXMLStreamReader() Returns the XMLStreamReader used by this StaxSource.
void	setInputSource(InputSource inputSource) Throws a UnsupportedOperationException.
void	setXMLReader(XMLReader reader) Throws a UnsupportedOperationException.

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

getInputSource, getSystemId, getXMLReader, setSystemId, sourceToInputSource

Methods inherited from class java.lang.Object

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

Constructor Detail

StaxSource

public StaxSource(XMLStreamReader streamReader)

Constructs a new instance of the StaxSource with the specified XMLStreamReader. The supplied stream reader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Parameters:

streamReader - the XMLStreamReader to read from

Throws:

IllegalStateException - if the reader is not at the start of a document or element

StaxSource

public StaxSource(XMLEventReader eventReader)

Constructs a new instance of the StaxSource with the specified XMLEventReader. The supplied event reader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Parameters:

eventReader - the XMLEventReader to read from

Throws:

IllegalStateException - if the reader is not at the start of a document or element

Method Detail

getXMLEventReader

public XMLEventReader getXMLEventReader()

Returns the XMLEventReader used by this StaxSource. If this StaxSource was created with an XMLStreamReader, the result will be null.

Returns:

the StAX event reader used by this source

See Also:

StaxSource(javax.xml.stream.XMLEventReader)

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

Returns the XMLStreamReader used by this StaxSource. If this StaxSource was created with an XMLEventReader, the result will be null.

Returns:

the StAX event reader used by this source

See Also:

StaxSource(javax.xml.stream.XMLEventReader)

setInputSource

public void setInputSource(InputSource inputSource)

Throws a UnsupportedOperationException.

Overrides:

setInputSource in class SAXSource

Throws:

UnsupportedOperationException - always

setXMLReader

public void setXMLReader(XMLReader reader)

Throws a UnsupportedOperationException.

Overrides:

setXMLReader in class SAXSource

Throws:

UnsupportedOperationException - always