| /* XMLEvent.java -- | |
| Copyright (C) 2005,2006 Free Software Foundation, Inc. | |
| This file is part of GNU Classpath. | |
| GNU Classpath is free software; you can redistribute it and/or modify | |
| it under the terms of the GNU General Public License as published by | |
| the Free Software Foundation; either version 2, or (at your option) | |
| any later version. | |
| GNU Classpath is distributed in the hope that it will be useful, but | |
| WITHOUT ANY WARRANTY; without even the implied warranty of | |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| General Public License for more details. | |
| You should have received a copy of the GNU General Public License | |
| along with GNU Classpath; see the file COPYING. If not, write to the | |
| Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
| 02110-1301 USA. | |
| Linking this library statically or dynamically with other modules is | |
| making a combined work based on this library. Thus, the terms and | |
| conditions of the GNU General Public License cover the whole | |
| combination. | |
| As a special exception, the copyright holders of this library give you | |
| permission to link this library with independent modules to produce an | |
| executable, regardless of the license terms of these independent | |
| modules, and to copy and distribute the resulting executable under | |
| terms of your choice, provided that you also meet, for each linked | |
| independent module, the terms and conditions of the license of that | |
| module. An independent module is a module which is not derived from | |
| or based on this library. If you modify this library, you may extend | |
| this exception to your version of the library, but you are not | |
| obligated to do so. If you do not wish to do so, delete this | |
| exception statement from your version. */ | |
| package javax.xml.stream.events; | |
| import java.io.Writer; | |
| import javax.xml.namespace.QName; | |
| import javax.xml.stream.Location; | |
| import javax.xml.stream.XMLStreamConstants; | |
| import javax.xml.stream.XMLStreamException; | |
| /** | |
| * An XML stream event. | |
| */ | |
| public interface XMLEvent | |
| extends XMLStreamConstants | |
| { | |
| /** | |
| * Returns the type of this event. | |
| */ | |
| int getEventType(); | |
| /** | |
| * Returns the location of this event. | |
| */ | |
| Location getLocation(); | |
| /** | |
| * Indicates whether this event is a start-element event. | |
| */ | |
| boolean isStartElement(); | |
| /** | |
| * Indicates whether this event is an attribute event. | |
| */ | |
| boolean isAttribute(); | |
| /** | |
| * Indicates whether this event is a namespace declaration event. | |
| */ | |
| boolean isNamespace(); | |
| /** | |
| * Indicates whether this event is an end-element event. | |
| */ | |
| boolean isEndElement(); | |
| /** | |
| * Indicates whether this event is an entity reference event. | |
| */ | |
| boolean isEntityReference(); | |
| /** | |
| * Indicates whether this event is a processing instruction event. | |
| */ | |
| boolean isProcessingInstruction(); | |
| /** | |
| * Indicates whether this event is a text event. | |
| */ | |
| boolean isCharacters(); | |
| /** | |
| * Indicates whether this event is a start-document event. | |
| */ | |
| boolean isStartDocument(); | |
| /** | |
| * Indicates whether this event is an end-document event. | |
| */ | |
| boolean isEndDocument(); | |
| /** | |
| * Returns this event as a start-element event. | |
| */ | |
| StartElement asStartElement(); | |
| /** | |
| * Returns this event as an end-element event. | |
| */ | |
| EndElement asEndElement(); | |
| /** | |
| * Returns this event as a text event. | |
| */ | |
| Characters asCharacters(); | |
| /** | |
| * Returns schema-related type information about this event, or null if | |
| * not available. | |
| */ | |
| QName getSchemaType(); | |
| /** | |
| * Writes this event to the specified writer. | |
| */ | |
| void writeAsEncodedUnicode(Writer writer) | |
| throws XMLStreamException; | |
| } | |