1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
font color='#880088'> package javax.xml.stream.events; import java.io.Writer; import javax.xml.namespace.QName; /** * This is the base event interface for handling markup events. * Events are value objects that are used to communicate the * XML 1.0 InfoSet to the Application. Events may be cached * and referenced after the parse has completed. * * @version 1.0 * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved. * @see javax.xml.stream.XMLEventReader * @see Characters * @see ProcessingInstruction * @see StartElement * @see EndElement * @see StartDocument * @see EndDocument * @see EntityReference * @see EntityDeclaration * @see NotationDeclaration * @since 1.6 */ public interface XMLEvent extends javax.xml.stream.XMLStreamConstants { /** * Returns an integer code for this event. * @see #START_ELEMENT * @see #END_ELEMENT * @see #CHARACTERS * @see #ATTRIBUTE * @see #NAMESPACE * @see #PROCESSING_INSTRUCTION * @see #COMMENT * @see #START_DOCUMENT * @see #END_DOCUMENT * @see #DTD */ public int getEventType(); /** * Return the location of this event. The Location * returned from this method is non-volatile and * will retain its information. * @see javax.xml.stream.Location */ javax.xml.stream.Location getLocation(); /** * A utility function to check if this event is a StartElement. * @see StartElement */ public boolean isStartElement(); /** * A utility function to check if this event is an Attribute. * @see Attribute */ public boolean isAttribute(); /** * A utility function to check if this event is a Namespace. * @see Namespace */ public boolean isNamespace(); /** * A utility function to check if this event is a EndElement. * @see EndElement */ public boolean isEndElement(); /** * A utility function to check if this event is an EntityReference. * @see EntityReference */ public boolean isEntityReference(); /** * A utility function to check if this event is a ProcessingInstruction. * @see ProcessingInstruction */ public boolean isProcessingInstruction(); /** * A utility function to check if this event is Characters. * @see Characters */ public boolean isCharacters(); /** * A utility function to check if this event is a StartDocument. * @see StartDocument */ public boolean isStartDocument(); /** * A utility function to check if this event is an EndDocument. * @see EndDocument */ public boolean isEndDocument(); /** * Returns this event as a start element event, may result in * a class cast exception if this event is not a start element. */ public StartElement asStartElement(); /** * Returns this event as an end element event, may result in * a class cast exception if this event is not a end element. */ public EndElement asEndElement(); /** * Returns this event as Characters, may result in * a class cast exception if this event is not Characters. */ public Characters asCharacters(); /** * This method is provided for implementations to provide * optional type information about the associated event. * It is optional and will return null if no information * is available. */ public QName getSchemaType(); /** * This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. * No indentation or whitespace should be outputted. * * Any user defined event type SHALL have this method * called when being written to on an output stream. * Built in Event types MUST implement this method, * but implementations MAY choose not call these methods * for optimizations reasons when writing out built in * Events to an output stream. * The output generated MUST be equivalent in terms of the * infoset expressed. * * @param writer The writer that will output the data * @throws XMLStreamException if there is a fatal error writing the event */ public void writeAsEncodedUnicode(Writer writer) throws javax.xml.stream.XMLStreamException; }