Top Description Fields Constructors Methods
org.springframework.util.xml

pack-priv abstract Class AbstractXMLEventReader

extends Object
implements XMLEventReader
Class Inheritance
All Implemented Interfaces
javax.xml.stream.XMLEventReader, java.util.Iterator
Known Direct Subclasses
org.springframework.util.xml.ListBasedXMLEventReader
Imports
java.util.NoSuchElementException, javax.xml.stream.XMLEventReader, .XMLStreamException, org.springframework.util.ClassUtils
Abstract base class for XMLEventReaders.
Authors
Arjen Poutsma, Juergen Hoeller
Since
5.0

Field Summary

Modifier and TypeField and Description
private boolean
closed

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractXMLEventReader()

Method Summary

Modifier and TypeMethod and Description
protected void
checkIfClosed()

Check if the reader is closed, and throws a XMLStreamException if so.

public void
close()

Implements javax.xml.stream.XMLEventReader.close.

Frees any resources associated with this Reader.

public Object
getProperty(String
The name of the property
name)

Implements javax.xml.stream.XMLEventReader.getProperty.

This implementation throws an IllegalArgumentException for any property.

public Object
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

closedback to summary
private boolean closed

Constructor Detail

AbstractXMLEventReaderback to summary
pack-priv AbstractXMLEventReader()

Method Detail

checkIfClosedback to summary
protected void checkIfClosed() throws XMLStreamException

Check if the reader is closed, and throws a XMLStreamException if so.

Exceptions
XMLStreamException:
if the reader is closed
See Also
close()
closeback to summary
public void close()

Implements javax.xml.stream.XMLEventReader.close.

Doc from javax.xml.stream.XMLEventReader.close.

Frees any resources associated with this Reader. This method does not close the underlying input source.

Annotations
@Override
getPropertyback to summary
public Object getProperty(String name) throws IllegalArgumentException

Implements javax.xml.stream.XMLEventReader.getProperty.

This implementation throws an IllegalArgumentException for any property.

Parameters
name:String

Doc from javax.xml.stream.XMLEventReader.getProperty.

The name of the property

Returns:Object

Doc from javax.xml.stream.XMLEventReader.getProperty.

The value of the property

Annotations
@Override
Exceptions
IllegalArgumentException:
when called
nextback to summary
public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Object

the next element in the iteration

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to 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, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override