View Javadoc
1   /*
2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3    *
4    * This code is free software; you can redistribute it and/or modify it
5    * under the terms of the GNU General Public License version 2 only, as
6    * published by the Free Software Foundation.  Oracle designates this
7    * particular file as subject to the "Classpath" exception as provided
8    * by Oracle in the LICENSE file that accompanied this code.
9    *
10   * This code is distributed in the hope that it will be useful, but WITHOUT
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13   * version 2 for more details (a copy is included in the LICENSE file that
14   * accompanied this code).
15   *
16   * You should have received a copy of the GNU General Public License version
17   * 2 along with this work; if not, write to the Free Software Foundation,
18   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19   *
20   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21   * or visit www.oracle.com if you need additional information or have any
22   * questions.
23   */
24  
25  package javax.xml.stream;
26  
27  /**
28   * This interface declares the constants used in this API.
29   * Numbers in the range 0 to 256 are reserved for the specification,
30   * user defined events must use event codes outside that range.
31   *
32   * @since 1.6
33   */
34  
35  public interface XMLStreamConstants {
36    /**
37     * Indicates an event is a start element
38     * @see javax.xml.stream.events.StartElement
39     */
40    public static final int START_ELEMENT=1;
41    /**
42     * Indicates an event is an end element
43     * @see javax.xml.stream.events.EndElement
44     */
45    public static final int END_ELEMENT=2;
46    /**
47     * Indicates an event is a processing instruction
48     * @see javax.xml.stream.events.ProcessingInstruction
49     */
50    public static final int PROCESSING_INSTRUCTION=3;
51  
52    /**
53     * Indicates an event is characters
54     * @see javax.xml.stream.events.Characters
55     */
56    public static final int CHARACTERS=4;
57  
58    /**
59     * Indicates an event is a comment
60     * @see javax.xml.stream.events.Comment
61     */
62    public static final int COMMENT=5;
63  
64    /**
65     * The characters are white space
66     * (see [XML], 2.10 "White Space Handling").
67     * Events are only reported as SPACE if they are ignorable white
68     * space.  Otherwise they are reported as CHARACTERS.
69     * @see javax.xml.stream.events.Characters
70     */
71    public static final int SPACE=6;
72  
73    /**
74     * Indicates an event is a start document
75     * @see javax.xml.stream.events.StartDocument
76     */
77    public static final int START_DOCUMENT=7;
78  
79    /**
80     * Indicates an event is an end document
81     * @see javax.xml.stream.events.EndDocument
82     */
83    public static final int END_DOCUMENT=8;
84  
85    /**
86     * Indicates an event is an entity reference
87     * @see javax.xml.stream.events.EntityReference
88     */
89    public static final int ENTITY_REFERENCE=9;
90  
91    /**
92     * Indicates an event is an attribute
93     * @see javax.xml.stream.events.Attribute
94     */
95    public static final int ATTRIBUTE=10;
96  
97    /**
98     * Indicates an event is a DTD
99     * @see javax.xml.stream.events.DTD
100    */
101   public static final int DTD=11;
102 
103   /**
104    * Indicates an event is a CDATA section
105    * @see javax.xml.stream.events.Characters
106    */
107   public static final int CDATA=12;
108 
109   /**
110    * Indicates the event is a namespace declaration
111    *
112    * @see javax.xml.stream.events.Namespace
113    */
114   public static final int NAMESPACE=13;
115 
116   /**
117    * Indicates a Notation
118    * @see javax.xml.stream.events.NotationDeclaration
119    */
120   public static final int NOTATION_DECLARATION=14;
121 
122   /**
123    * Indicates a Entity Declaration
124    * @see javax.xml.stream.events.NotationDeclaration
125    */
126   public static final int ENTITY_DECLARATION=15;
127 }