JAXB OSGI 4.0.9 · com.sun.xml.fastinfoset.stax.events.StAXEventReader

Modifier and Type	Field and Description
private XMLEvent	_currentEvent
protected XMLEventAllocator	_eventAllocator
protected XMLStreamReader	_streamReader
private int	currentIndex
private XMLEvent[]	events
private boolean	hasEvent
private int	size

Access	Constructor and Description
public	StAXEventReader(XMLStreamReader reader)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements javax.xml.stream.XMLEventReader.close. Frees any resources associated with this Reader.
public String	getElementText() Implements javax.xml.stream.XMLEventReader.getElementText. Reads the content of a text-only element.
public Object	Returns: The value of the property getProperty(String The name of the property name) Implements javax.xml.stream.XMLEventReader.getProperty. Get the value of a feature/property from the underlying implementation
public boolean	hasNext() Implements javax.xml.stream.XMLEventReader.hasNext. Check if there are more events.
public Object	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public XMLEvent	nextEvent() Implements javax.xml.stream.XMLEventReader.nextEvent. Gets the next XMLEvent.
public XMLEvent	nextTag() Implements javax.xml.stream.XMLEventReader.nextTag. Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
public XMLEvent	peek() Implements javax.xml.stream.XMLEventReader.peek. Check the next XMLEvent without reading it from the stream.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
public void	setAllocator(XMLEventAllocator allocator)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_currentEvent	back to summary
private XMLEvent _currentEvent

_eventAllocator	back to summary
protected XMLEventAllocator _eventAllocator

_streamReader	back to summary
protected XMLStreamReader _streamReader

currentIndex	back to summary
private int currentIndex

events	back to summary
private XMLEvent[] events

hasEvent	back to summary
private boolean hasEvent

size	back to summary
private int size

StAXEventReader	back to summary
public StAXEventReader(XMLStreamReader reader) throws XMLStreamException

Method Detail

close	back to summary
public void close() throws XMLStreamException 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 Exceptions XMLStreamException: if there are errors freeing associated resources

back to summary

public void close() throws XMLStreamException

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

Exceptions

XMLStreamException:: if there are errors freeing associated resources

getElementText	back to summary
public String getElementText() throws XMLStreamException Implements javax.xml.stream.XMLEventReader.getElementText. Reads the content of a text-only element. Precondition the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT. Annotations @Override Exceptions XMLStreamException: if the current event is not a START_ELEMENT or if a non text element is encountered

getElementText

back to summary

public String getElementText() throws XMLStreamException

Implements javax.xml.stream.XMLEventReader.getElementText.

Reads the content of a text-only element.

Precondition

the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.

Annotations

@Override

Exceptions

XMLStreamException:: if the current event is not a START_ELEMENT or if a non text element is encountered

getProperty	back to summary
public Object getProperty(String name) throws IllegalArgumentException Implements javax.xml.stream.XMLEventReader.getProperty. Get the value of a feature/property from the underlying implementation Parameters name:String The name of the property Returns:Object The value of the property Annotations @Override Exceptions IllegalArgumentException: if the property is not supported

getProperty

back to summary

public Object getProperty(String name) throws IllegalArgumentException

Implements javax.xml.stream.XMLEventReader.getProperty.

Get the value of a feature/property from the underlying implementation

Parameters

name:String: The name of the property

Returns:Object

The value of the property

Annotations

@Override

Exceptions

IllegalArgumentException:: if the property is not supported

hasNext	back to summary
public boolean hasNext() Implements javax.xml.stream.XMLEventReader.hasNext. Doc from javax.xml.stream.XMLEventReader.hasNext. Check if there are more events. Returns true if there are more events and false otherwise. Annotations @Override

hasNext

back to summary

public boolean hasNext()

Implements javax.xml.stream.XMLEventReader.hasNext.

Doc from javax.xml.stream.XMLEventReader.hasNext.

Check if there are more events. Returns true if there are more events and false otherwise.

Annotations

@Override

next	back to summary
public Object next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Annotations @Override

back to summary

public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Annotations

@Override

nextEvent back to summary

nextEvent	back to summary
public XMLEvent nextEvent() throws XMLStreamException Implements javax.xml.stream.XMLEventReader.nextEvent. Doc from javax.xml.stream.XMLEventReader.nextEvent. Gets the next XMLEvent. The initial event is `StartDocument`. Annotations @Override Exceptions XMLStreamException: if there is an error with the underlying XML.

public XMLEvent nextEvent() throws XMLStreamException

Implements javax.xml.stream.XMLEventReader.nextEvent.

Doc from javax.xml.stream.XMLEventReader.nextEvent.

Gets the next XMLEvent. The initial event is StartDocument.

Annotations

@Override

Exceptions

XMLStreamException:: if there is an error with the underlying XML.

nextTag	back to summary
public XMLEvent nextTag() throws XMLStreamException Implements javax.xml.stream.XMLEventReader.nextTag. 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. Annotations @Override Exceptions XMLStreamException: if anything other than space characters are encountered

nextTag

back to summary

public XMLEvent nextTag() throws XMLStreamException

Implements javax.xml.stream.XMLEventReader.nextTag.

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.

Annotations

@Override

Exceptions

XMLStreamException:: if anything other than space characters are encountered

peek	back to summary
public XMLEvent peek() throws XMLStreamException Implements javax.xml.stream.XMLEventReader.peek. Doc from javax.xml.stream.XMLEventReader.peek. 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(). Annotations @Override Exceptions XMLStreamException: if an error occurs

peek

back to summary

public XMLEvent peek() throws XMLStreamException

Implements javax.xml.stream.XMLEventReader.peek.

Doc from javax.xml.stream.XMLEventReader.peek.

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().

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

remove back to summary

remove	back 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

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

setAllocator	back to summary
public void setAllocator(XMLEventAllocator allocator)

public Class StAXEventReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail