Class StAXReader
- All Implemented Interfaces:
XMLReader
-
Nested Class Summary
-
Field Summary
-
Constructor Summary
ConstructorDescriptionStAXReader
(StringReader stringReader, boolean rejectDTDs) StAXReader
(Source source, boolean rejectDTDs) StAXReader
(InputSource source, boolean rejectDTDs) StAXReader
(InputSource source, boolean rejectDTDs, XMLStreamReader reader) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close the XMLReader.Return the current attribute list.int
Return the current element ID.int
Return the current line number.Return the current local name.getName()
Return the current qualified name.Return an iterator on all prefixes in scope, except for the default prefix.int
getState()
Return the current state of the XMLReader.getURI()
Return the current URI.Return the URI for the given prefix.getValue()
Return the current value.Returns the StAX XMLStreamReader that is being used.int
next()
Return the next state of the XMLReader.Records the current element and leaves the reader positioned on its end tag.void
skipElement
(int id) Skip all nodes up to the end tag of the element with the given element ID.void
Used to resync the StAXReader with its underlying XMLStreamReader.Methods inherited from class com.sun.xml.rpc.streaming.XMLReaderBase
nextContent, nextElementContent, skipElement
-
Constructor Details
-
StAXReader
-
StAXReader
-
StAXReader
-
StAXReader
-
-
Method Details
-
getXMLStreamReader
Returns the StAX XMLStreamReader that is being used. If this is called, the code must call StAXReader.synchronize() after the stream reader has been used so that the StAXReader has correct information.- Returns:
- The actual XMLStreamReader being used. The StAXReader object will not contain valid information once the underlying reader is used separately.
- See Also:
-
synchronizeReader
public void synchronizeReader()Used to resync the StAXReader with its underlying XMLStreamReader. The element id stack may not be valid.- See Also:
-
next
public int next()Description copied from interface:XMLReader
Return the next state of the XMLReader. The return value is one of: START, END, CHARS, PI, EOF. -
getState
public int getState()Description copied from interface:XMLReader
Return the current state of the XMLReader. -
getName
Description copied from interface:XMLReader
Return the current qualified name.Meaningful only when the state is one of: START, END.
-
getLocalName
Description copied from interface:XMLReader
Return the current local name.Meaningful only when the state is one of: START, END, PI.
-
getURI
Description copied from interface:XMLReader
Return the current URI.Meaningful only when the state is one of: START, END.
-
getAttributes
Description copied from interface:XMLReader
Return the current attribute list.Meaningful only when the state is one of: START.
The returned
Attributes
object belong to the XMLReader and is only guaranteed to be valid until theXMLReader.next()
method is called, directly or indirectly. -
getURI
Description copied from interface:XMLReader
Return the URI for the given prefix.If there is no namespace declaration in scope for the given prefix, return null.
-
getValue
Description copied from interface:XMLReader
Return the current value.Meaningful only when the state is one of: CHARS, PI.
-
getLineNumber
public int getLineNumber()Description copied from interface:XMLReader
Return the current line number.Due to aggressive parsing, this value may be off by a few lines.
-
getPrefixes
Description copied from interface:XMLReader
Return an iterator on all prefixes in scope, except for the default prefix. -
getElementId
public int getElementId()Description copied from interface:XMLReader
Return the current element ID. -
skipElement
public void skipElement(int id) Description copied from interface:XMLReader
Skip all nodes up to the end tag of the element with the given element ID.- Specified by:
skipElement
in interfaceXMLReader
- Specified by:
skipElement
in classXMLReaderBase
-
recordElement
Description copied from interface:XMLReader
Records the current element and leaves the reader positioned on its end tag.The XMLReader must be positioned on the start tag of the element. The returned reader will play back all events starting with the start tag of the element and ending with its end tag.
-
close
public void close()Description copied from interface:XMLReader
Close the XMLReader.All subsequent calls to
XMLReader.next()
will return EOF.
-