1 /* XMLEvent.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.events; 39 40 import java.io.Writer; 41 import javax.xml.namespace.QName; 42 import javax.xml.stream.Location; 43 import javax.xml.stream.XMLStreamConstants; 44 import javax.xml.stream.XMLStreamException; 45 46 /** 47 * An XML stream event. 48 */ 49 public interface XMLEvent 50 extends XMLStreamConstants 51 { 52 53 /** 54 * Returns the type of this event. 55 */ getEventType()56 int getEventType(); 57 58 /** 59 * Returns the location of this event. 60 */ getLocation()61 Location getLocation(); 62 63 /** 64 * Indicates whether this event is a start-element event. 65 */ isStartElement()66 boolean isStartElement(); 67 68 /** 69 * Indicates whether this event is an attribute event. 70 */ isAttribute()71 boolean isAttribute(); 72 73 /** 74 * Indicates whether this event is a namespace declaration event. 75 */ isNamespace()76 boolean isNamespace(); 77 78 /** 79 * Indicates whether this event is an end-element event. 80 */ isEndElement()81 boolean isEndElement(); 82 83 /** 84 * Indicates whether this event is an entity reference event. 85 */ isEntityReference()86 boolean isEntityReference(); 87 88 /** 89 * Indicates whether this event is a processing instruction event. 90 */ isProcessingInstruction()91 boolean isProcessingInstruction(); 92 93 /** 94 * Indicates whether this event is a text event. 95 */ isCharacters()96 boolean isCharacters(); 97 98 /** 99 * Indicates whether this event is a start-document event. 100 */ isStartDocument()101 boolean isStartDocument(); 102 103 /** 104 * Indicates whether this event is an end-document event. 105 */ isEndDocument()106 boolean isEndDocument(); 107 108 /** 109 * Returns this event as a start-element event. 110 */ asStartElement()111 StartElement asStartElement(); 112 113 /** 114 * Returns this event as an end-element event. 115 */ asEndElement()116 EndElement asEndElement(); 117 118 /** 119 * Returns this event as a text event. 120 */ asCharacters()121 Characters asCharacters(); 122 123 /** 124 * Returns schema-related type information about this event, or null if 125 * not available. 126 */ getSchemaType()127 QName getSchemaType(); 128 129 /** 130 * Writes this event to the specified writer. 131 */ writeAsEncodedUnicode(Writer writer)132 void writeAsEncodedUnicode(Writer writer) 133 throws XMLStreamException; 134 135 } 136