Package org.jdom2.output.support
Class AbstractStAXStreamReader
java.lang.Object
org.jdom2.output.support.AbstractOutputProcessor
org.jdom2.output.support.AbstractStAXStreamReader
- All Implemented Interfaces:
XMLStreamConstants
,XMLStreamReader
public abstract class AbstractStAXStreamReader
extends AbstractOutputProcessor
implements XMLStreamReader
An
XMLStreamReader
implementation that reads the XML document
out of a JDOM Document
. This class is marked as abstract even though it is
a full implementation of the XMLReader. This class can be overridden if needed.
If you extend this class, you will need to also extend AbstractStAXStreamReaderProcessor
and supply an instance of that customised class to the StAXStreamReader
class.
The reader reads XML Events by walking the JDOM tree, reporting all XML stream events as it encounters them in the JDOM.
This class is the inverse of the class StAXStreamOutputter
in the sense that
this class is read from (it's an XMLStreamReader implementation) by interpreting a JDOM
Document whereas the StAXStreamOutputter interprets a JDOM Document and writes to
a user-supplied XMLStreamWriter. It is the difference between a 'pull' concept and a
'push' concept.
- Since:
- JDOM 2.1
- Author:
- gordon burgett https://github.com/gburgett, Rolf Lear
-
Field Summary
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractStAXStreamReader
(Document document) Create a new AbstractStAXStreamReader that outputs a JDOM Document as an XMLStream using the Format.getRawFormat() format.AbstractStAXStreamReader
(Document document, Format format) Create a new AbstractStAXStreamReader that outputs a JDOM Document as an XMLStream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
int
getAttributeLocalName
(int index) getAttributeName
(int index) getAttributeNamespace
(int index) getAttributePrefix
(int index) getAttributeType
(int index) getAttributeValue
(int index) getAttributeValue
(String namespaceURI, String localName) int
getName()
int
getNamespacePrefix
(int index) getNamespaceURI
(int index) getNamespaceURI
(String prefix) getProperty
(String name) getText()
char[]
int
getTextCharacters
(int sourceStart, char[] target, int targetStart, int length) int
int
boolean
hasName()
boolean
hasNext()
boolean
hasText()
boolean
isAttributeSpecified
(int index) boolean
boolean
boolean
boolean
boolean
int
next()
int
nextTag()
void
boolean
Methods inherited from class org.jdom2.output.support.AbstractOutputProcessor
buildWalker
-
Constructor Details
-
AbstractStAXStreamReader
Create a new AbstractStAXStreamReader that outputs a JDOM Document as an XMLStream.- Parameters:
document
- the document to output.format
- The output format to use.
-
AbstractStAXStreamReader
Create a new AbstractStAXStreamReader that outputs a JDOM Document as an XMLStream using the Format.getRawFormat() format.- Parameters:
document
- the document to output.
-
-
Method Details
-
hasNext
- Specified by:
hasNext
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
next
- Specified by:
next
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getEventType
public int getEventType()- Specified by:
getEventType
in interfaceXMLStreamReader
-
isStartElement
public boolean isStartElement()- Specified by:
isStartElement
in interfaceXMLStreamReader
-
isEndElement
public boolean isEndElement()- Specified by:
isEndElement
in interfaceXMLStreamReader
-
isCharacters
public boolean isCharacters()- Specified by:
isCharacters
in interfaceXMLStreamReader
-
isWhiteSpace
public boolean isWhiteSpace()- Specified by:
isWhiteSpace
in interfaceXMLStreamReader
-
require
- Specified by:
require
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getName
- Specified by:
getName
in interfaceXMLStreamReader
-
getLocalName
- Specified by:
getLocalName
in interfaceXMLStreamReader
-
hasName
public boolean hasName()- Specified by:
hasName
in interfaceXMLStreamReader
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getPrefix
- Specified by:
getPrefix
in interfaceXMLStreamReader
-
getPITarget
- Specified by:
getPITarget
in interfaceXMLStreamReader
-
getPIData
- Specified by:
getPIData
in interfaceXMLStreamReader
-
getElementText
- Specified by:
getElementText
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
nextTag
- Specified by:
nextTag
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
close
- Specified by:
close
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getAttributeValue
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
getAttributeCount
public int getAttributeCount()- Specified by:
getAttributeCount
in interfaceXMLStreamReader
-
getAttributeName
- Specified by:
getAttributeName
in interfaceXMLStreamReader
-
getAttributeNamespace
- Specified by:
getAttributeNamespace
in interfaceXMLStreamReader
-
getAttributeLocalName
- Specified by:
getAttributeLocalName
in interfaceXMLStreamReader
-
getAttributePrefix
- Specified by:
getAttributePrefix
in interfaceXMLStreamReader
-
getAttributeType
- Specified by:
getAttributeType
in interfaceXMLStreamReader
-
getAttributeValue
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
isAttributeSpecified
public boolean isAttributeSpecified(int index) - Specified by:
isAttributeSpecified
in interfaceXMLStreamReader
-
getNamespaceCount
public int getNamespaceCount()- Specified by:
getNamespaceCount
in interfaceXMLStreamReader
-
getNamespacePrefix
- Specified by:
getNamespacePrefix
in interfaceXMLStreamReader
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getNamespaceContext
- Specified by:
getNamespaceContext
in interfaceXMLStreamReader
-
hasText
public boolean hasText()- Specified by:
hasText
in interfaceXMLStreamReader
-
getText
- Specified by:
getText
in interfaceXMLStreamReader
-
getTextCharacters
public char[] getTextCharacters()- Specified by:
getTextCharacters
in interfaceXMLStreamReader
-
getTextCharacters
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException - Specified by:
getTextCharacters
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getTextStart
public int getTextStart()- Specified by:
getTextStart
in interfaceXMLStreamReader
-
getTextLength
public int getTextLength()- Specified by:
getTextLength
in interfaceXMLStreamReader
-
getEncoding
- Specified by:
getEncoding
in interfaceXMLStreamReader
-
getLocation
- Specified by:
getLocation
in interfaceXMLStreamReader
-
getVersion
- Specified by:
getVersion
in interfaceXMLStreamReader
-
isStandalone
public boolean isStandalone()- Specified by:
isStandalone
in interfaceXMLStreamReader
-
standaloneSet
public boolean standaloneSet()- Specified by:
standaloneSet
in interfaceXMLStreamReader
-
getCharacterEncodingScheme
- Specified by:
getCharacterEncodingScheme
in interfaceXMLStreamReader
-
getProperty
- Specified by:
getProperty
in interfaceXMLStreamReader
- Throws:
IllegalArgumentException
-