Source for javax.xml.stream.XMLEventReader

   1: /* XMLEventReader.java -- 
   2:    Copyright (C) 2005,2006  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.xml.stream;
  39: 
  40: import java.util.Iterator;
  41: import javax.xml.stream.events.XMLEvent;
  42: 
  43: /**
  44:  * An XML parser.
  45:  */
  46: public interface XMLEventReader
  47:   extends Iterator
  48: {
  49: 
  50:   /**
  51:    * Returns the next XML event.
  52:    */
  53:   XMLEvent nextEvent()
  54:     throws XMLStreamException;
  55: 
  56:   /**
  57:    * Indicates whether there are more XML events to be read.
  58:    */
  59:   boolean hasNext();
  60:   
  61:   /**
  62:    * Looks at the next XML event without advancing the cursor in the stream.
  63:    * Returns <code>null</code> if there are no more events to read.
  64:    */
  65:   XMLEvent peek()
  66:     throws XMLStreamException;
  67: 
  68:   /**
  69:    * Reads the text context of an element.
  70:    * When invoked, the current event must be START_ELEMENT.
  71:    * On completion, the current event will be END_ELEMENT.
  72:    */
  73:   String getElementText()
  74:     throws XMLStreamException;
  75: 
  76:   /**
  77:    * Returns the next element event.
  78:    * This method skips insignificant space until a START_ELEMENT or
  79:    * END_ELEMENT event is found.
  80:    * @exception XMLStreamException if an event that was not an insignificant
  81:    * space event was encountered
  82:    */
  83:   XMLEvent nextTag()
  84:     throws XMLStreamException;
  85: 
  86:   /**
  87:    * Returns the implementation-specific feature or property of the given
  88:    * name.
  89:    * @exception IllegalArgumentException if the property is not supported
  90:    */
  91:   Object getProperty(String name)
  92:     throws IllegalArgumentException;
  93: 
  94:   /**
  95:    * Free any resources associated with this parser.
  96:    * This method will not close the underlying input source.
  97:    */
  98:   void close()
  99:     throws XMLStreamException;
 100: 
 101: }