XMLEventReader (Java EE 5)

This is the top level interface for parsing XML Events. It provides the ability to peek at the next event and returns configuration information through the property interface.

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

XMLInputFactory, XMLEventWriter

public XMLEvent nextEvent() throws XMLStreamException
获取下一个 XMLEvent。

Throws	XMLStreamException: 如果底层 XML 存在错误。
Throws	NoSuchElementException: 没有元素可以迭代。
See also	javax.xml.stream.events.XMLEvent

英文文档：

nextEvent

XMLEvent nextEvent()
                   throws XMLStreamException

Get the next XMLEvent

Throws:

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

NoSuchElementException - iteration has no more elements.

See Also:

XMLEvent

public boolean hasNext()
检查是否有多个事件。如果有多个事件，则返回 true，否则返回 false。

return

如果事件 reader 具有多个事件，则返回 true，否则返回 false。

英文文档：

hasNext

boolean hasNext()

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

Specified by:

hasNext in interface Iterator

Returns:

true if the event reader has more events, false otherwise

public XMLEvent peek() throws XMLStreamException
检查下一个 XMLEvent，但不从流中读取它。如果流位于 EOF 处或者不再有 XMLEvent，则返回 null。调用 peek() 将相当于 next() 的下一个返回。

Throws	XMLStreamException:
See also	javax.xml.stream.events.XMLEvent

英文文档：

peek

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

Throws:

XMLStreamException

See Also:

XMLEvent

public String getElementText() throws XMLStreamException
读取纯文本元素的内容。前置条件：当前事件是 START_ELEMENT。后置条件：当前事件是相应的 END_ELEMENT。

Throws

XMLStreamException: 如果当前事件不是 START_ELEMENT 或者遇到了非文本元素

英文文档：

getElementText

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.

Throws:

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

public XMLEvent nextTag() throws XMLStreamException
在到达 START_ELEMENT 或 END_ELEMENT 之前，跳过所有无意义的空格事件。如果遇到空格符之外的其他内容，则抛出异常。在处理纯元素内容时应使用此方法，因为如果缺少 DTD 或未解释它，解析器将无法识别可忽略的空格。

Throws

XMLStreamException: 如果遇到空格符之外的其他内容

英文文档：

nextTag

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.

Throws:

XMLStreamException - if anything other than space characters are encountered

public Object getProperty(String name) throws IllegalArgumentException
从底层实现获取功能/属性的值。

name	属性的名称
return	属性的值
Throws	IllegalArgumentException: 如果属性不受支持

英文文档：

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException

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

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

IllegalArgumentException - if the property is not supported

public void close() throws XMLStreamException
释放与此 Reader 关联的所有资源。此方法不会关闭底层输入源。

Throws

XMLStreamException: 如果释放关联资源时发生错误

英文文档：

close

void close()
           throws XMLStreamException

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

Throws:

XMLStreamException - if there are errors freeing associated resources

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.