public class

StAXSource

extends Object
implements Source
java.lang.Object
   ↳ javax.xml.transform.stax.StAXSource

Class Overview

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

StAXSources are consumed during processing and are not reusable.

See Also

Summary

Constants
String FEATURE If getFeature(String) returns true when passed this value as an argument, the Transformer supports Source input of this type.
Public Constructors
StAXSource(XMLEventReader xmlEventReader)

Creates a new instance of a StAXSource by supplying an XMLEventReader.

StAXSource(XMLStreamReader xmlStreamReader)

Creates a new instance of a StAXSource by supplying an XMLStreamReader.

Public Methods
String getSystemId()

Get the system identifier used by this StAXSource.

XMLEventReader getXMLEventReader()

Get the XMLEventReader used by this StAXSource.

XMLStreamReader getXMLStreamReader()

Get the XMLStreamReader used by this StAXSource.

void setSystemId(String systemId)

In the context of a StAXSource, it is not appropriate to explicitly set the system identifier.

[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.xml.transform.Source

Constants

public static final String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Source input of this type.

Constant Value: "http://javax.xml.transform.stax.StAXSource/feature"

Public Constructors

public StAXSource (XMLEventReader xmlEventReader)

Creates a new instance of a StAXSource by supplying an XMLEventReader.

XMLEventReader must be a non-null reference.

XMLEventReader must be in START_DOCUMENT or START_ELEMENT state.

Parameters
xmlEventReader XMLEventReader used to create this StAXSource.
Throws
XMLStreamException If xmlEventReader access throws an Exception.
IllegalArgumentException If xmlEventReader == null.
IllegalStateException If xmlEventReader is not in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

public StAXSource (XMLStreamReader xmlStreamReader)

Creates a new instance of a StAXSource by supplying an XMLStreamReader.

XMLStreamReader must be a non-null reference.

XMLStreamReader must be in START_DOCUMENT or START_ELEMENT state.

Parameters
xmlStreamReader XMLStreamReader used to create this StAXSource.
Throws
IllegalArgumentException If xmlStreamReader == null.
IllegalStateException If xmlStreamReader is not in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Public Methods

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.

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.

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.

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 UnsupportedOperationException is always thrown by this method.

Parameters
systemId Ignored.
Throws
UnsupportedOperationException Is always thrown by this method.