Class StAXSource
- All Implemented Interfaces:
- 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 SummaryFieldsModifier and TypeFieldDescriptionstatic final StringIfTransformerFactory.getFeature(String name)returns true when passed this value as an argument, the Transformer supports Source input of this type.
- 
Constructor SummaryConstructorsConstructorDescriptionStAXSource(XMLEventReader xmlEventReader) Creates a new instance of aStAXSourceby supplying anXMLEventReader.StAXSource(XMLStreamReader xmlStreamReader) Creates a new instance of aStAXSourceby supplying anXMLStreamReader.
- 
Method SummaryModifier and TypeMethodDescriptionGet the system identifier used by thisStAXSource.Get theXMLEventReaderused by thisStAXSource.Get theXMLStreamReaderused by thisStAXSource.booleanisEmpty()Indicates whether theStAXSourceobject is empty.voidsetSystemId(String systemId) In the context of aStAXSource, it is not appropriate to explicitly set the system identifier.
- 
Field Details- 
FEATUREIfTransformerFactory.getFeature(String name)returns true when passed this value as an argument, the Transformer supports Source input of this type.- See Also:
 
 
- 
- 
Constructor Details- 
StAXSourceCreates a new instance of a StAXSourceby supplying anXMLEventReader.XMLEventReadermust be a non-nullreference.XMLEventReadermust be inXMLStreamConstants.START_DOCUMENTorXMLStreamConstants.START_ELEMENTstate.- Parameters:
- xmlEventReader-- XMLEventReaderused to create this- StAXSource.
- Throws:
- XMLStreamException- If- xmlEventReaderaccess throws an- Exception.
- IllegalArgumentException- If- xmlEventReader==- null.
- IllegalStateException- If- xmlEventReaderis not in- XMLStreamConstants.START_DOCUMENTor- XMLStreamConstants.START_ELEMENTstate.
 
- 
StAXSourceCreates a new instance of a StAXSourceby supplying anXMLStreamReader.XMLStreamReadermust be a non-nullreference.XMLStreamReadermust be inXMLStreamConstants.START_DOCUMENTorXMLStreamConstants.START_ELEMENTstate.- Parameters:
- xmlStreamReader-- XMLStreamReaderused to create this- StAXSource.
- Throws:
- IllegalArgumentException- If- xmlStreamReader==- null.
- IllegalStateException- If- xmlStreamReaderis not in- XMLStreamConstants.START_DOCUMENTor- XMLStreamConstants.START_ELEMENTstate.
 
 
- 
- 
Method Details- 
getXMLEventReaderGet the XMLEventReaderused by thisStAXSource.XMLEventReaderwill benull. if thisStAXSourcewas created with aXMLStreamReader.- Returns:
- XMLEventReaderused by this- StAXSource.
 
- 
getXMLStreamReaderGet the XMLStreamReaderused by thisStAXSource.XMLStreamReaderwill benullif thisStAXSourcewas created with aXMLEventReader.- Returns:
- XMLStreamReaderused by this- StAXSource.
 
- 
setSystemIdIn the context of a StAXSource, it is not appropriate to explicitly set the system identifier. TheXMLStreamReaderorXMLEventReaderused to construct thisStAXSourcedetermines the system identifier of the XML source.An UnsupportedOperationExceptionis always thrown by this method.- Specified by:
- setSystemIdin interface- Source
- Parameters:
- systemId- Ignored.
- Throws:
- UnsupportedOperationException- Is always thrown by this method.
 
- 
getSystemIdGet the system identifier used by this StAXSource.The XMLStreamReaderorXMLEventReaderused to construct thisStAXSourceis queried to determine the system identifier of the XML source.The system identifier may be nullor an empty""String.- Specified by:
- getSystemIdin interface- Source
- Returns:
- System identifier used by this StAXSource.
 
- 
isEmpty
 
-