XMLEvent (Java Platform SE 8 ) (original) (raw)

All Superinterfaces:
XMLStreamConstants
All Known Subinterfaces:
Attribute, Characters, Comment, DTD, EndDocument, EndElement, EntityDeclaration, EntityReference, Namespace, NotationDeclaration, ProcessingInstruction, StartDocument, StartElement

public interface XMLEvent
extends XMLStreamConstants
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.
Since:
1.6
Version:
1.0
See Also:
XMLEventReader, Characters, ProcessingInstruction, StartElement, EndElement, StartDocument, EndDocument, EntityReference, EntityDeclaration, NotationDeclaration

Field Summary

 * ### Fields inherited from interface javax.xml.stream.[XMLStreamConstants](../../../../javax/xml/stream/XMLStreamConstants.html "interface in javax.xml.stream")  
 `[ATTRIBUTE](../../../../javax/xml/stream/XMLStreamConstants.html#ATTRIBUTE), [CDATA](../../../../javax/xml/stream/XMLStreamConstants.html#CDATA), [CHARACTERS](../../../../javax/xml/stream/XMLStreamConstants.html#CHARACTERS), [COMMENT](../../../../javax/xml/stream/XMLStreamConstants.html#COMMENT), [DTD](../../../../javax/xml/stream/XMLStreamConstants.html#DTD), [END_DOCUMENT](../../../../javax/xml/stream/XMLStreamConstants.html#END%5FDOCUMENT), [END_ELEMENT](../../../../javax/xml/stream/XMLStreamConstants.html#END%5FELEMENT), [ENTITY_DECLARATION](../../../../javax/xml/stream/XMLStreamConstants.html#ENTITY%5FDECLARATION), [ENTITY_REFERENCE](../../../../javax/xml/stream/XMLStreamConstants.html#ENTITY%5FREFERENCE), [NAMESPACE](../../../../javax/xml/stream/XMLStreamConstants.html#NAMESPACE), [NOTATION_DECLARATION](../../../../javax/xml/stream/XMLStreamConstants.html#NOTATION%5FDECLARATION), [PROCESSING_INSTRUCTION](../../../../javax/xml/stream/XMLStreamConstants.html#PROCESSING%5FINSTRUCTION), [SPACE](../../../../javax/xml/stream/XMLStreamConstants.html#SPACE), [START_DOCUMENT](../../../../javax/xml/stream/XMLStreamConstants.html#START%5FDOCUMENT), [START_ELEMENT](../../../../javax/xml/stream/XMLStreamConstants.html#START%5FELEMENT)`

Method Summary

All Methods Instance Methods Abstract Methods

Modifier and Type	Method	Description
Characters	asCharacters()	Returns this event as Characters, may result in a class cast exception if this event is not Characters.
EndElement	asEndElement()	Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
StartElement	asStartElement()	Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
int	getEventType()	Returns an integer code for this event.
Location	getLocation()	Return the location of this event.
QName	getSchemaType()	This method is provided for implementations to provide optional type information about the associated event.
boolean	isAttribute()	A utility function to check if this event is an Attribute.
boolean	isCharacters()	A utility function to check if this event is Characters.
boolean	isEndDocument()	A utility function to check if this event is an EndDocument.
boolean	isEndElement()	A utility function to check if this event is a EndElement.
boolean	isEntityReference()	A utility function to check if this event is an EntityReference.
boolean	isNamespace()	A utility function to check if this event is a Namespace.
boolean	isProcessingInstruction()	A utility function to check if this event is a ProcessingInstruction.
boolean	isStartDocument()	A utility function to check if this event is a StartDocument.
boolean	isStartElement()	A utility function to check if this event is a StartElement.
void	writeAsEncodedUnicode(Writer writer)	This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.

Method Detail

 * #### getEventType  
 int getEventType()  
 Returns an integer code for this event.  
 See Also:  
 [XMLStreamConstants.START\_ELEMENT](../../../../javax/xml/stream/XMLStreamConstants.html#START%5FELEMENT), [XMLStreamConstants.END\_ELEMENT](../../../../javax/xml/stream/XMLStreamConstants.html#END%5FELEMENT), [XMLStreamConstants.CHARACTERS](../../../../javax/xml/stream/XMLStreamConstants.html#CHARACTERS), [XMLStreamConstants.ATTRIBUTE](../../../../javax/xml/stream/XMLStreamConstants.html#ATTRIBUTE), [XMLStreamConstants.NAMESPACE](../../../../javax/xml/stream/XMLStreamConstants.html#NAMESPACE), [XMLStreamConstants.PROCESSING\_INSTRUCTION](../../../../javax/xml/stream/XMLStreamConstants.html#PROCESSING%5FINSTRUCTION), [XMLStreamConstants.COMMENT](../../../../javax/xml/stream/XMLStreamConstants.html#COMMENT), [XMLStreamConstants.START\_DOCUMENT](../../../../javax/xml/stream/XMLStreamConstants.html#START%5FDOCUMENT), [XMLStreamConstants.END\_DOCUMENT](../../../../javax/xml/stream/XMLStreamConstants.html#END%5FDOCUMENT), [XMLStreamConstants.DTD](../../../../javax/xml/stream/XMLStreamConstants.html#DTD)  
 * #### getLocation  
 [Location](../../../../javax/xml/stream/Location.html "interface in javax.xml.stream") getLocation()  
 Return the location of this event. The Location returned from this method is non-volatile and will retain its information.  
 See Also:  
 [Location](../../../../javax/xml/stream/Location.html "interface in javax.xml.stream")  
 * #### isStartElement  
 boolean isStartElement()  
 A utility function to check if this event is a StartElement.  
 See Also:  
 [StartElement](../../../../javax/xml/stream/events/StartElement.html "interface in javax.xml.stream.events")  
 * #### isAttribute  
 boolean isAttribute()  
 A utility function to check if this event is an Attribute.  
 See Also:  
 [Attribute](../../../../javax/xml/stream/events/Attribute.html "interface in javax.xml.stream.events")  
 * #### isNamespace  
 boolean isNamespace()  
 A utility function to check if this event is a Namespace.  
 See Also:  
 [Namespace](../../../../javax/xml/stream/events/Namespace.html "interface in javax.xml.stream.events")  
 * #### isEndElement  
 boolean isEndElement()  
 A utility function to check if this event is a EndElement.  
 See Also:  
 [EndElement](../../../../javax/xml/stream/events/EndElement.html "interface in javax.xml.stream.events")  
 * #### isEntityReference  
 boolean isEntityReference()  
 A utility function to check if this event is an EntityReference.  
 See Also:  
 [EntityReference](../../../../javax/xml/stream/events/EntityReference.html "interface in javax.xml.stream.events")  
 * #### isProcessingInstruction  
 boolean isProcessingInstruction()  
 A utility function to check if this event is a ProcessingInstruction.  
 See Also:  
 [ProcessingInstruction](../../../../javax/xml/stream/events/ProcessingInstruction.html "interface in javax.xml.stream.events")  
 * #### isCharacters  
 boolean isCharacters()  
 A utility function to check if this event is Characters.  
 See Also:  
 [Characters](../../../../javax/xml/stream/events/Characters.html "interface in javax.xml.stream.events")  
 * #### isStartDocument  
 boolean isStartDocument()  
 A utility function to check if this event is a StartDocument.  
 See Also:  
 [StartDocument](../../../../javax/xml/stream/events/StartDocument.html "interface in javax.xml.stream.events")  
 * #### isEndDocument  
 boolean isEndDocument()  
 A utility function to check if this event is an EndDocument.  
 See Also:  
 [EndDocument](../../../../javax/xml/stream/events/EndDocument.html "interface in javax.xml.stream.events")  
 * #### asStartElement  
 [StartElement](../../../../javax/xml/stream/events/StartElement.html "interface in javax.xml.stream.events") asStartElement()  
 Returns this event as a start element event, may result in a class cast exception if this event is not a start element.  
 * #### asEndElement  
 [EndElement](../../../../javax/xml/stream/events/EndElement.html "interface in javax.xml.stream.events") asEndElement()  
 Returns this event as an end element event, may result in a class cast exception if this event is not a end element.  
 * #### asCharacters  
 [Characters](../../../../javax/xml/stream/events/Characters.html "interface in javax.xml.stream.events") asCharacters()  
 Returns this event as Characters, may result in a class cast exception if this event is not Characters.  
 * #### getSchemaType  
 [QName](../../../../javax/xml/namespace/QName.html "class in javax.xml.namespace") getSchemaType()  
 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.  
 * #### writeAsEncodedUnicode  
 void writeAsEncodedUnicode([Writer](../../../../java/io/Writer.html "class in java.io") writer)  
                     throws [XMLStreamException](../../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
 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.  
 Parameters:  
 `writer` \- The writer that will output the data  
 Throws:  
 `XMLStreamException` \- if there is a fatal error writing the event

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

XMLEvent (Java Platform SE 8 ) (original) (raw)

Field Summary

Method Summary

Method Detail