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