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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FEATURE
    If TransformerFactory.getFeature(String name) returns true when passed this value as an argument, the Transformer supports Source input of this type.

  • Constructor Summary

    Constructors
    Constructor
    Description
    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.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    isEmpty()
    Indicates whether the StAXSource object is empty.
    void
    setSystemId(String systemId)
    In the context of a StAXSource, it is not appropriate to explicitly set the system identifier.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • 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