StAXSource (Java Platform SE 6) (original) (raw)
javax.xml.transform.stax
Class StAXSource
java.lang.Object
javax.xml.transform.stax.StAXSource
All Implemented Interfaces:
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 | |
|---|---|
| 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 |
|---|
| 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 | |
|---|---|
| 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 |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29) |
| Field Detail |
|---|
FEATURE
public 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.
See Also:
| Constructor Detail |
|---|
StAXSource
public StAXSource(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 inXMLStreamConstants.START_DOCUMENT orXMLStreamConstants.START_ELEMENT state.
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 orXMLStreamConstants.START_ELEMENT state.
StAXSource
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 inXMLStreamConstants.START_DOCUMENT orXMLStreamConstants.START_ELEMENT state.
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 orXMLStreamConstants.START_ELEMENT state.
| Method Detail |
|---|
getXMLEventReader
public XMLEventReader getXMLEventReader()
Get the XMLEventReader used by thisStAXSource.
XMLEventReader will be null. if this StAXSource was created with aXMLStreamReader.
Returns:
XMLEventReader used by thisStAXSource.
getXMLStreamReader
public XMLStreamReader getXMLStreamReader()
Get the XMLStreamReader used by thisStAXSource.
XMLStreamReader will be null if this StAXSource was created with aXMLEventReader.
Returns:
XMLStreamReader used by thisStAXSource.
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](../../../../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 getSystemId()
Get the system identifier used by thisStAXSource.
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 Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.