- java.lang.Object
-
- javax.xml.stream.util.EventReaderDelegate
-
- All Implemented Interfaces:
- Iterator, XMLEventReader
public class EventReaderDelegate extends Object implements XMLEventReader
This is the base class for deriving an XMLEventReader filter. This class is designed to sit between an XMLEventReader and an application's XMLEventReader. By default each method does nothing but call the corresponding method on the parent interface.- Since:
- 1.6
- See Also:
XMLEventReader
,StreamReaderDelegate
-
-
Constructor Summary
Constructors Constructor and Description EventReaderDelegate()
Construct an empty filter with no parent.EventReaderDelegate(XMLEventReader reader)
Construct an filter with the specified parent.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Frees any resources associated with this Reader.String
getElementText()
Reads the content of a text-only element.XMLEventReader
getParent()
Get the parent of this instance.Object
getProperty(String name)
Get the value of a feature/property from the underlying implementationboolean
hasNext()
Check if there are more events.Object
next()
Returns the next element in the iteration.XMLEvent
nextEvent()
Get the next XMLEventXMLEvent
nextTag()
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.XMLEvent
peek()
Check the next XMLEvent without reading it from the stream.void
remove()
Removes from the underlying collection the last element returned by this iterator (optional operation).void
setParent(XMLEventReader reader)
Set the parent of this instance.
-
-
-
Constructor Detail
-
EventReaderDelegate
public EventReaderDelegate()
Construct an empty filter with no parent.
-
EventReaderDelegate
public EventReaderDelegate(XMLEventReader reader)
Construct an filter with the specified parent.- Parameters:
reader
- the parent
-
-
Method Detail
-
setParent
public void setParent(XMLEventReader reader)
Set the parent of this instance.- Parameters:
reader
- the new parent
-
getParent
public XMLEventReader getParent()
Get the parent of this instance.- Returns:
- the parent or null if none is set
-
nextEvent
public XMLEvent nextEvent() throws XMLStreamException
Description copied from interface:XMLEventReader
Get the next XMLEvent- Specified by:
nextEvent
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if there is an error with the underlying XML.- See Also:
XMLEvent
-
next
public Object next()
Description copied from interface:Iterator
Returns the next element in the iteration.
-
hasNext
public boolean hasNext()
Description copied from interface:XMLEventReader
Check if there are more events. Returns true if there are more events and false otherwise.- Specified by:
hasNext
in interfaceIterator
- Specified by:
hasNext
in interfaceXMLEventReader
- Returns:
- true if the event reader has more events, false otherwise
-
peek
public XMLEvent peek() throws XMLStreamException
Description copied from interface:XMLEventReader
Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents. A call to peek() will be equal to the next return of next().- Specified by:
peek
in interfaceXMLEventReader
- Throws:
XMLStreamException
- See Also:
XMLEvent
-
close
public void close() throws XMLStreamException
Description copied from interface:XMLEventReader
Frees any resources associated with this Reader. This method does not close the underlying input source.- Specified by:
close
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if there are errors freeing associated resources
-
getElementText
public String getElementText() throws XMLStreamException
Description copied from interface:XMLEventReader
Reads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.- Specified by:
getElementText
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if the current event is not a START_ELEMENT or if a non text element is encountered
-
nextTag
public XMLEvent nextTag() throws XMLStreamException
Description copied from interface:XMLEventReader
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached. If anything other than space characters are encountered, an exception is thrown. This method should be used when processing element-only content because the parser is not able to recognize ignorable whitespace if the DTD is missing or not interpreted.- Specified by:
nextTag
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if anything other than space characters are encountered
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
Description copied from interface:XMLEventReader
Get the value of a feature/property from the underlying implementation- Specified by:
getProperty
in interfaceXMLEventReader
- Parameters:
name
- The name of the property- Returns:
- The value of the property
- Throws:
IllegalArgumentException
- if the property is not supported
-
remove
public void remove()
Description copied from interface:Iterator
Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call toIterator.next()
. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/stream/util/eventreaderdelegate.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.