OpenJDK 27 · javax.xml.transform.stax.StAXSource · APIdia, the JavaDoc alternative

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. javax.xml.transform.Transformer, javax.xml.validation.Validator which accept Source as input.

StAXSources are consumed during processing and are not reusable.

Field Summary

Modifier and Type	Field and Description
public static final String	FEATURE If `javax.xml.transform.TransformerFactory#getFeature(String name)` returns true when passed this value as an argument, the Transformer supports Source input of this type.
private String	systemId System identifier of source input.
private XMLEventReader	xmlEventReader `XMLEventReader` to be used for source input.
private XMLStreamReader	xmlStreamReader `XMLStreamReader` to be used for source input.

Constructor Summary

Access	Constructor and Description
public	StAXSource(final XMLEventReader `XMLEventReader` used to create this `StAXSource`. xmlEventReader) Creates a new instance of a `StAXSource` by supplying an `XMLEventReader`.
public	StAXSource(final XMLStreamReader `XMLStreamReader` used to create this `StAXSource`. xmlStreamReader) Creates a new instance of a `StAXSource` by supplying an `XMLStreamReader`.

Method Summary

Modifier and Type	Method and Description
public String	Returns: System identifier used by this `StAXSource`. getSystemId() Implements javax.xml.transform.Source.getSystemId. Get the system identifier used by this `StAXSource`.
public XMLEventReader	Returns: `XMLEventReader` used by this `StAXSource`. getXMLEventReader() Get the `XMLEventReader` used by this `StAXSource`.
public XMLStreamReader	Returns: `XMLStreamReader` used by this `StAXSource`. getXMLStreamReader() Get the `XMLStreamReader` used by this `StAXSource`.
public boolean	Returns: unconditionally false isEmpty() Overrides default javax.xml.transform.Source.isEmpty. Indicates whether the `StAXSource` object is empty.
public void	setSystemId(final String Ignored. systemId) Implements javax.xml.transform.Source.setSystemId. In the context of a `StAXSource`, it is not appropriate to explicitly set the system identifier.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FEATURE	back to summary
public static final String FEATURE If `javax.xml.transform.TransformerFactory#getFeature(String name)` returns true when passed this value as an argument, the Transformer supports Source input of this type.

systemId	back to summary
private String systemId System identifier of source input.

xmlEventReader	back to summary
private XMLEventReader xmlEventReader `XMLEventReader` to be used for source input.

xmlStreamReader	back to summary
private XMLStreamReader xmlStreamReader `XMLStreamReader` to be used for source input.

Constructor Detail

StAXSource back to summary

StAXSource	back to summary
public StAXSource(final XMLEventReader xmlEventReader) throws XMLStreamException Creates a new instance of a `StAXSource` by supplying an `XMLEventReader`. `XMLEventReader` must be a non-`null` reference. `XMLEventReader` must be in `XMLStreamConstants#START_DOCUMENT` or `XMLStreamConstants#START_ELEMENT` state. Parameters xmlEventReader:XMLEventReader `XMLEventReader` used to create this `StAXSource`. Exceptions 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(final XMLEventReader xmlEventReader) throws XMLStreamException

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

XMLEventReader must be a non-null reference.

XMLEventReader must be in XMLStreamConstants#START_DOCUMENT or XMLStreamConstants#START_ELEMENT state.

Parameters

xmlEventReader:XMLEventReader: XMLEventReader used to create this StAXSource.

Exceptions

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.

StAXSource back to summary

StAXSource	back to summary
public StAXSource(final XMLStreamReader xmlStreamReader) Creates a new instance of a `StAXSource` by supplying an `XMLStreamReader`. `XMLStreamReader` must be a non-`null` reference. `XMLStreamReader` must be in `XMLStreamConstants#START_DOCUMENT` or `XMLStreamConstants#START_ELEMENT` state. Parameters xmlStreamReader:XMLStreamReader `XMLStreamReader` used to create this `StAXSource`. Exceptions IllegalArgumentException: If `xmlStreamReader` == `null`. IllegalStateException: If `xmlStreamReader` is not in `XMLStreamConstants.START_DOCUMENT` or `XMLStreamConstants.START_ELEMENT` state.

public StAXSource(final XMLStreamReader xmlStreamReader)

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

XMLStreamReader must be a non-null reference.

XMLStreamReader must be in XMLStreamConstants#START_DOCUMENT or XMLStreamConstants#START_ELEMENT state.

Parameters

xmlStreamReader:XMLStreamReader: XMLStreamReader used to create this StAXSource.

Exceptions

IllegalArgumentException:: If xmlStreamReader == null.
IllegalStateException:: If xmlStreamReader is not in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Method Detail

getSystemId back to summary

getSystemId	back to summary
public String getSystemId() Implements javax.xml.transform.Source.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:String System identifier used by this `StAXSource`. Annotations @Override

public String getSystemId()

Implements javax.xml.transform.Source.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:String

System identifier used by this StAXSource.

Annotations

@Override

getXMLEventReader back to summary

getXMLEventReader	back to summary
public XMLEventReader getXMLEventReader() Get the `XMLEventReader` used by this `StAXSource`. `XMLEventReader` will be `null`. if this `StAXSource` was created with a `XMLStreamReader`. Returns:XMLEventReader `XMLEventReader` 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: XMLEventReader used by this StAXSource.

getXMLStreamReader back to summary

getXMLStreamReader	back to summary
public XMLStreamReader getXMLStreamReader() Get the `XMLStreamReader` used by this `StAXSource`. `XMLStreamReader` will be `null` if this `StAXSource` was created with a `XMLEventReader`. Returns:XMLStreamReader `XMLStreamReader` 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: XMLStreamReader used by this StAXSource.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides default javax.xml.transform.Source.isEmpty. Indicates whether the `StAXSource` object is empty. Since a `StAXSource` object can never be empty, this method always returns false. Returns:boolean unconditionally false Annotations @Override

public boolean isEmpty()

Overrides default javax.xml.transform.Source.isEmpty.

Indicates whether the StAXSource object is empty. Since a StAXSource object can never be empty, this method always returns false.

Returns:boolean

unconditionally false

Annotations

@Override

setSystemId back to summary

setSystemId	back to summary
public void setSystemId(final String systemId) Implements javax.xml.transform.Source.setSystemId. 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:String Ignored. Annotations @Override Exceptions UnsupportedOperationException: Is always thrown by this method.

public void setSystemId(final String systemId)

Implements javax.xml.transform.Source.setSystemId.

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:String: Ignored.

Annotations

@Override

Exceptions

UnsupportedOperationException:: Is always thrown by this method.

public Class StAXSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail