javax.xml.transform.stax
class StAXSource

java.lang.Object javax.xml.transform.stax.StAXSource

All Implemented Interfaces:

Source

public class StAXSource
extends Object
implements Source

Acts as a holder for an XML {@link Source} in the form of a StAX reader,i.e. {@link XMLStreamReader} or {@link XMLEventReader}. StAXSource can be used in all cases that accept a Source, e.g. {@link javax.xml.transform.Transformer}, {@link javax.xml.validation.Validator} which accept Source as input.

StAXSources are consumed during processing and are not reusable.

FEATURE

public static final String FEATURE

If {@link javax.xml.transform.TransformerFactory#getFeature(String name)} returns true when passed this value as an argument, the Transformer supports Source input of this type.

StAXSource

public StAXSource(XMLEventReader xmlEventReader)
           throws XMLStreamException

Creates a new instance of a StAXSource by supplying an {@link XMLEventReader}.

XMLEventReader must be a non-null reference.

XMLEventReader must be in {@link XMLStreamConstants#START_DOCUMENT} or {@link XMLStreamConstants#START_ELEMENT} state.

Parameters:

xmlEventReader - XMLEventReader used to create this StAXSource.

Throws:

XMLStreamException - If xmlEventReader access throws an Exception.

StAXSource

public StAXSource(XMLStreamReader xmlStreamReader)

Creates a new instance of a StAXSource by supplying an {@link XMLStreamReader}.

XMLStreamReader must be a non-null reference.

XMLStreamReader must be in {@link XMLStreamConstants#START_DOCUMENT} or {@link XMLStreamConstants#START_ELEMENT} state.

Parameters:

xmlStreamReader - XMLStreamReader used to create this StAXSource.

getSystemId

public String getSystemId()

Get the system identifier used by this StAXSource.

The XMLStreamReader or XMLEventReader used to construct this StAXSource is queried to determine the system identifier of the XML source.

The system identifier may be null or an empty "" String.

Returns:

System identifier used by this StAXSource.

getXMLEventReader

public XMLEventReader getXMLEventReader()

Get the XMLEventReader used by this StAXSource.

XMLEventReader will be null. if this StAXSource was created with a XMLStreamReader.

Returns:

XMLEventReader used by this StAXSource.

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

Get the XMLStreamReader used by this StAXSource.

XMLStreamReader will be null if this StAXSource was created with a XMLEventReader.

Returns:

XMLStreamReader used by this StAXSource.

setSystemId

public void setSystemId(String systemId)

In the context of a StAXSource, it is not appropriate to explicitly set the system identifier. The XMLStreamReader or XMLEventReader used to construct this StAXSource determines the system identifier of the XML source.

An {@link UnsupportedOperationException} is always thrown by this method.

Parameters:

systemId - Ignored.