Save This Page
Home » openjdk-7 » javax » xml » stream » events » [javadoc | source]
javax.xml.stream.events
public interface: XMLEvent [javadoc | source]

All Implemented Interfaces:
    XMLStreamConstants

All Known Implementing Classes:
    EndDocument, StartDocument, EntityReference, ProcessingInstruction, EntityDeclaration, Attribute, EndElement, EndEntity, StartEntity, Namespace, DTD, Comment, NotationDeclaration, Characters, StartElement

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.
Method from javax.xml.stream.events.XMLEvent Summary:
asCharacters,   asEndElement,   asStartElement,   getEventType,   getLocation,   getSchemaType,   isAttribute,   isCharacters,   isEndDocument,   isEndElement,   isEntityReference,   isNamespace,   isProcessingInstruction,   isStartDocument,   isStartElement,   writeAsEncodedUnicode
Method from javax.xml.stream.events.XMLEvent Detail:
 public Characters asCharacters()
    Returns this event as Characters, may result in
a class cast exception if this event is not Characters.
 public 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 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 int getEventType()
    Returns an integer code for this event.
 public Location getLocation()
    Return the location of this event. The Location
returned from this method is non-volatile and
will retain its information.
 public 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 boolean isAttribute()
    A utility function to check if this event is an Attribute.
 public boolean isCharacters()
    A utility function to check if this event is Characters.
 public boolean isEndDocument()
    A utility function to check if this event is an EndDocument.
 public boolean isEndElement()
    A utility function to check if this event is a EndElement.
 public boolean isEntityReference()
    A utility function to check if this event is an EntityReference.
 public boolean isNamespace()
    A utility function to check if this event is a Namespace.
 public boolean isProcessingInstruction()
    A utility function to check if this event is a ProcessingInstruction.
 public boolean isStartDocument()
    A utility function to check if this event is a StartDocument.
 public boolean isStartElement()
    A utility function to check if this event is a StartElement.
 public  void writeAsEncodedUnicode(Writer writer) throws XMLStreamException
    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.