XMLEvent
implements XMLStreamConstants| javax.xml.stream.events.XMLEvent |
 Known Indirect Subclasses
|
Class Overview
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.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
javax.xml.stream.XMLStreamConstants
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns this event as Characters, may result in
a class cast exception if this event is not Characters.
| |||||||||||
Returns this event as an end element event, may result in
a class cast exception if this event is not a end element.
| |||||||||||
Returns this event as a start element event, may result in
a class cast exception if this event is not a start element.
| |||||||||||
Returns an integer code for this event.
| |||||||||||
Return the location of this event.
| |||||||||||
This method is provided for implementations to provide
optional type information about the associated event.
| |||||||||||
A utility function to check if this event is an Attribute.
| |||||||||||
A utility function to check if this event is Characters.
| |||||||||||
A utility function to check if this event is an EndDocument.
| |||||||||||
A utility function to check if this event is a EndElement.
| |||||||||||
A utility function to check if this event is an EntityReference.
| |||||||||||
A utility function to check if this event is a Namespace.
| |||||||||||
A utility function to check if this event is a ProcessingInstruction.
| |||||||||||
A utility function to check if this event is a StartDocument.
| |||||||||||
A utility function to check if this event is a StartElement.
| |||||||||||
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
| |||||||||||
Public Methods
public abstract Characters asCharacters ()
Returns this event as Characters, may result in a class cast exception if this event is not Characters.
public abstract 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.
public abstract 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.
public abstract int getEventType ()
Returns an integer code for this event.
public abstract Location getLocation ()
Return the location of this event. The Location returned from this method is non-volatile and will retain its information.
See Also
public abstract QName 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.
public abstract boolean isAttribute ()
A utility function to check if this event is an Attribute.
See Also
public abstract boolean isCharacters ()
A utility function to check if this event is Characters.
See Also
public abstract boolean isEndDocument ()
A utility function to check if this event is an EndDocument.
See Also
public abstract boolean isEndElement ()
A utility function to check if this event is a EndElement.
See Also
public abstract boolean isEntityReference ()
A utility function to check if this event is an EntityReference.
See Also
public abstract boolean isNamespace ()
A utility function to check if this event is a Namespace.
See Also
public abstract boolean isProcessingInstruction ()
A utility function to check if this event is a ProcessingInstruction.
See Also
public abstract boolean isStartDocument ()
A utility function to check if this event is a StartDocument.
See Also
public abstract boolean isStartElement ()
A utility function to check if this event is a StartElement.
See Also
public abstract void writeAsEncodedUnicode (Writer writer)
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
| if there is a fatal error writing the event | |
| XMLStreamException |