StAXSource (Java Platform SE 7 ) (original) (raw)

• 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 acceptSource 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 Summary

  Fields

  Modifier and Type	Field and Description
  static 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 and 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

  Methods

  Modifier and Type	Method and Description
  String	getSystemId() Get the system identifier used by thisStAXSource.
  XMLEventReader	getXMLEventReader() Get the XMLEventReader used by thisStAXSource.
  XMLStreamReader	getXMLStreamReader() Get the XMLStreamReader used by thisStAXSource.
  void	setSystemId(String systemId) In the context of a StAXSource, it is not appropriate to explicitly set the system identifier.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone%28%29), [equals](../../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java/lang/Object.html#finalize%28%29), [getClass](../../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../../java/lang/Object.html#hashCode%28%29), [notify](../../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../../java/lang/Object.html#toString%28%29), [wait](../../../../java/lang/Object.html#wait%28%29), [wait](../../../../java/lang/Object.html#wait%28long%29), [wait](../../../../java/lang/Object.html#wait%28long,%20int%29)`

• • Field Detail

     * #### FEATURE  
     public static final [String](../../../../java/lang/String.html "class in java.lang") FEATURE  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.transform.stax.StAXSource.FEATURE)  

  • Constructor Detail

    * #### StAXSource  
    public StAXSource([XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream") xmlEventReader)  
               throws [XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
    Parameters:  
    `xmlEventReader` \- `XMLEventReader` used to create this `StAXSource`.  
    Throws:  
    `[XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- If `xmlEventReader` access throws an `Exception`.  
    `[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `xmlEventReader` \==`null`.  
    `[IllegalStateException](../../../../java/lang/IllegalStateException.html "class in java.lang")` \- If `xmlEventReader` is not in `XMLStreamConstants.START_DOCUMENT` or`XMLStreamConstants.START_ELEMENT` state.  
    * #### StAXSource  
    public StAXSource([XMLStreamReader](../../../../javax/xml/stream/XMLStreamReader.html "interface in javax.xml.stream") xmlStreamReader)  
    Parameters:  
    `xmlStreamReader` \- `XMLStreamReader` used to create this `StAXSource`.  
    Throws:  
    `[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `xmlStreamReader` \==`null`.  
    `[IllegalStateException](../../../../java/lang/IllegalStateException.html "class in java.lang")` \- If `xmlStreamReader` is not in `XMLStreamConstants.START_DOCUMENT` or`XMLStreamConstants.START_ELEMENT` state.  

  • Method Detail

    * #### getXMLEventReader  
    public [XMLEventReader](../../../../javax/xml/stream/XMLEventReader.html "interface in javax.xml.stream") 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](../../../../javax/xml/stream/XMLStreamReader.html "interface in javax.xml.stream") 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](../../../../java/lang/String.html "class in java.lang") 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](../../../../java/lang/UnsupportedOperationException.html "class in java.lang") is **always** thrown by this method.  
    **Specified by:**  
    `[setSystemId](../../../../javax/xml/transform/Source.html#setSystemId%28java.lang.String%29)` in interface `[Source](../../../../javax/xml/transform/Source.html "interface in javax.xml.transform")`  
    Parameters:  
    `systemId` \- Ignored.  
    Throws:  
    `[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- Is **always** thrown by this method.  
    * #### getSystemId  
    public [String](../../../../java/lang/String.html "class in java.lang") 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](../../../../javax/xml/transform/Source.html#getSystemId%28%29)` in interface `[Source](../../../../javax/xml/transform/Source.html "interface in javax.xml.transform")`  
    Returns:  
    System identifier used by this `StAXSource`.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.