OpenJDK 27 · javax.xml.stream.XMLEventReader · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	close() Frees any resources associated with this Reader.
public String	Returns: the text of the element 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) Get the value of a feature/property from the underlying implementation
public boolean	Returns: true if the event reader has more events, false otherwise hasNext() Redeclares java.util.Iterator.hasNext. Check if there are more events.
public XMLEvent	Returns: the next XMLEvent nextEvent() Gets the next XMLEvent.
public XMLEvent	Returns: a START_ELEMENT or END_ELEMENT nextTag() Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
public XMLEvent	Returns: the next XMLEvent peek() Check the next XMLEvent without reading it from the stream.

Inherited from java.util.Iterator:: forEachRemaining next remove

Method Detail

close	back to summary
public void close() throws XMLStreamException Frees any resources associated with this Reader. This method does not close the underlying input source. Exceptions XMLStreamException: if there are errors freeing associated resources

back to summary

public void close() throws XMLStreamException

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

Exceptions

XMLStreamException:: if there are errors freeing associated resources

getElementText	back to summary
public String getElementText() throws XMLStreamException Reads the content of a text-only element. Precondition the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT. Returns:String the text of the element 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

Reads the content of a text-only element.

Precondition

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

Returns:String

the text of the element

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 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 Exceptions IllegalArgumentException: if the property is not supported

getProperty

back to summary

public Object getProperty(String name) throws IllegalArgumentException

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

Exceptions

IllegalArgumentException:: if the property is not supported

hasNext	back to summary
public boolean hasNext() Redeclares java.util.Iterator.hasNext. Check if there are more events. Returns true if there are more events and false otherwise. Returns:boolean true if the event reader has more events, false otherwise Annotations @Override

hasNext

back to summary

public boolean hasNext()

Redeclares java.util.Iterator.hasNext.

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

Returns:boolean

true if the event reader has more events, false otherwise

Annotations

@Override

nextEvent back to summary

nextEvent	back to summary
public XMLEvent nextEvent() throws XMLStreamException Gets the next XMLEvent. The initial event is `StartDocument`. Returns:XMLEvent the next XMLEvent Exceptions XMLStreamException: if there is an error with the underlying XML. NoSuchElementException: iteration has no more elements. See Also `XMLEvent`

public XMLEvent nextEvent() throws XMLStreamException

Gets the next XMLEvent. The initial event is StartDocument.

Returns:XMLEvent

the next XMLEvent

Exceptions

XMLStreamException:: if there is an error with the underlying XML.
NoSuchElementException:: iteration has no more elements.

See Also

XMLEvent

nextTag	back to summary
public XMLEvent nextTag() throws XMLStreamException 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. Returns:XMLEvent a START_ELEMENT or END_ELEMENT Exceptions XMLStreamException: if anything other than space characters are encountered

nextTag

back to summary

public XMLEvent nextTag() throws XMLStreamException

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.

Returns:XMLEvent

a START_ELEMENT or END_ELEMENT

Exceptions

XMLStreamException:: if anything other than space characters are encountered

peek back to summary

peek	back to summary
public XMLEvent peek() throws XMLStreamException 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(). Returns:XMLEvent the next XMLEvent Exceptions XMLStreamException: if an error occurs See Also `XMLEvent`

public XMLEvent peek() throws XMLStreamException

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

Returns:XMLEvent

the next XMLEvent

Exceptions

XMLStreamException:: if an error occurs

See Also

XMLEvent

public Interface XMLEventReader

Method Summary

Method Detail