001/* XMLEventReader.java -- 002 Copyright (C) 2005,2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.xml.stream; 039 040import java.util.Iterator; 041import javax.xml.stream.events.XMLEvent; 042 043/** 044 * An XML parser. 045 */ 046@SuppressWarnings("unchecked") 047public interface XMLEventReader 048 extends Iterator 049{ 050 051 /** 052 * Returns the next XML event. 053 */ 054 XMLEvent nextEvent() 055 throws XMLStreamException; 056 057 /** 058 * Indicates whether there are more XML events to be read. 059 */ 060 boolean hasNext(); 061 062 /** 063 * Looks at the next XML event without advancing the cursor in the stream. 064 * Returns <code>null</code> if there are no more events to read. 065 */ 066 XMLEvent peek() 067 throws XMLStreamException; 068 069 /** 070 * Reads the text context of an element. 071 * When invoked, the current event must be START_ELEMENT. 072 * On completion, the current event will be END_ELEMENT. 073 */ 074 String getElementText() 075 throws XMLStreamException; 076 077 /** 078 * Returns the next element event. 079 * This method skips insignificant space until a START_ELEMENT or 080 * END_ELEMENT event is found. 081 * @exception XMLStreamException if an event that was not an insignificant 082 * space event was encountered 083 */ 084 XMLEvent nextTag() 085 throws XMLStreamException; 086 087 /** 088 * Returns the implementation-specific feature or property of the given 089 * name. 090 * @exception IllegalArgumentException if the property is not supported 091 */ 092 Object getProperty(String name) 093 throws IllegalArgumentException; 094 095 /** 096 * Free any resources associated with this parser. 097 * This method will not close the underlying input source. 098 */ 099 void close() 100 throws XMLStreamException; 101 102} 103