JavaTM Platform
Standard Ed. 6

javax.xml.stream
接口 XMLEventReader

所有超级接口:
Iterator
所有已知实现类:
EventReaderDelegate

public interface XMLEventReader
     
extends Iterator

此类是用于解析 XML 事件的顶层接口。它提供查看下一个事件和返回属性接口中的配置信息的功能。

从以下版本开始:
1.6
另请参见:
XMLInputFactory, XMLEventWriter

方法摘要
 void close()
          释放所有与此 Reader 关联的资源。
 String getElementText()
          读取纯文本元素的内容。
 Object getProperty(String name)
          从底层实现获取功能/属性值。
 boolean hasNext()
          检查是否有多个事件。
 XMLEvent nextEvent()
          获取下一个 XMLEvent。
 XMLEvent nextTag()
          在到达 START_ELEMENT 或 END_ELEMENT 之前,跳过所有无意义的空格事件。
 XMLEvent peek()
          检查下一个 XMLEvent,但不从流中读取它。
 
从接口 java.util.Iterator 继承的方法
next, remove
 

方法详细信息

nextEvent

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

抛出:
XMLStreamException - 如果底层 XML 存在错误。
NoSuchElementException - 迭代不再有元素。
另请参见:
XMLEvent

hasNext

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

指定者:
接口 Iterator 中的 hasNext
返回:
如果事件 reader 具有多个事件,则返回 true,否则返回 false。

peek

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

抛出:
XMLStreamException
另请参见:
XMLEvent

getElementText

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

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

nextTag

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

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

getProperty

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

参数:
name - 属性的名称
返回:
属性的值
抛出:
IllegalArgumentException - 如果属性不受支持

close

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

抛出:
XMLStreamException - 如果释放关联资源时出现错误

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策