XMLEventReader (Java EE 5 SDK)

Java

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


javax.xml.stream Interface XMLEventReader

所有父接口:
Iterator
所有已知实现子孙类:
EventReaderDelegate

public interface XMLEventReader
extends Iterator

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.

版本:
1.0
作者:
Copyright (c) 2003 by BEA Systems. All Rights Reserved.
另请参见:
XMLInputFactory, XMLEventWriter

方法摘要
 void close()
          Frees any resources associated with this Reader.
 String getElementText()
          Reads the content of a text-only element.
 Object getProperty(String name)
          Get the value of a feature/property from the underlying implementation
 boolean hasNext()
          Check if there are more events.
 XMLEvent nextEvent()
          Get the next XMLEvent
 XMLEvent nextTag()
          Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
 XMLEvent peek()
          Check the next XMLEvent without reading it from the stream.
 
Methods inherited from interface java.util.Iterator
next, remove
 

方法详细信息

nextEvent

XMLEvent nextEvent()
                   throws XMLStreamException
Get the next XMLEvent

抛出异常:
XMLStreamException - if there is an error with the underlying XML.
NoSuchElementException - iteration has no more elements.
另请参见:
XMLEvent

hasNext

boolean hasNext()
Check if there are more events. Returns true if there are more events and false otherwise.

规范说明:
hasNext in interface Iterator
返回:
true if the event reader has more events, false otherwise

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

抛出异常:
XMLStreamException
另请参见:
XMLEvent

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.

抛出异常:
XMLStreamException - if the current event is not a START_ELEMENT or if a non text element is encountered

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.

抛出异常:
XMLStreamException - if anything other than space characters are encountered

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException
Get the value of a feature/property from the underlying implementation

参数:
name - The name of the property
返回:
The value of the property
抛出异常:
IllegalArgumentException - if the property is not supported

close

void close()
           throws XMLStreamException
Frees any resources associated with this Reader. This method does not close the underlying input source.

抛出异常:
XMLStreamException - if there are errors freeing associated resources

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


提交错误或意见

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.