001/* XMLEvent.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.events;
039
040import java.io.Writer;
041import javax.xml.namespace.QName;
042import javax.xml.stream.Location;
043import javax.xml.stream.XMLStreamConstants;
044import javax.xml.stream.XMLStreamException;
045
046/**
047 * An XML stream event.
048 */
049public interface XMLEvent
050  extends XMLStreamConstants
051{
052
053  /**
054   * Returns the type of this event.
055   */
056  int getEventType();
057
058  /**
059   * Returns the location of this event.
060   */
061  Location getLocation();
062
063  /**
064   * Indicates whether this event is a start-element event.
065   */
066  boolean isStartElement();
067
068  /**
069   * Indicates whether this event is an attribute event.
070   */
071  boolean isAttribute();
072
073  /**
074   * Indicates whether this event is a namespace declaration event.
075   */
076  boolean isNamespace();
077
078  /**
079   * Indicates whether this event is an end-element event.
080   */
081  boolean isEndElement();
082
083  /**
084   * Indicates whether this event is an entity reference event.
085   */
086  boolean isEntityReference();
087
088  /**
089   * Indicates whether this event is a processing instruction event.
090   */
091  boolean isProcessingInstruction();
092
093  /**
094   * Indicates whether this event is a text event.
095   */
096  boolean isCharacters();
097
098  /**
099   * Indicates whether this event is a start-document event.
100   */
101  boolean isStartDocument();
102
103  /**
104   * Indicates whether this event is an end-document event.
105   */
106  boolean isEndDocument();
107
108  /**
109   * Returns this event as a start-element event.
110   */
111  StartElement asStartElement();
112
113  /**
114   * Returns this event as an end-element event.
115   */
116  EndElement asEndElement();
117
118  /**
119   * Returns this event as a text event.
120   */
121  Characters asCharacters();
122
123  /**
124   * Returns schema-related type information about this event, or null if
125   * not available.
126   */
127  QName getSchemaType();
128  
129  /**
130   * Writes this event to the specified writer.
131   */
132  void writeAsEncodedUnicode(Writer writer)
133    throws XMLStreamException;
134  
135}
136