Module java.xml

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 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.

Since:
1.6
See Also:
JSR 173: Streaming API for XML, XMLStreamReader, XMLEventReader
  • Field Details

  • Constructor Details

  • Method Details

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

      Specified by:
      setSystemId in interface Source
      Parameters:
      systemId - Ignored.
      Throws:
      UnsupportedOperationException - Is always thrown by this method.
    • 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.

      Specified by:
      getSystemId in interface Source
      Returns:
      System identifier used by this StAXSource.
    • isEmpty

      public boolean isEmpty()
      Indicates whether the StAXSource object is empty. Since a StAXSource object can never be empty, this method always returns false.
      Specified by:
      isEmpty in interface Source
      Returns:
      unconditionally false