javanet.staxutils.events

Interface ExtendedXMLEvent

All Superinterfaces:

javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

All Known Implementing Classes:

AbstractCharactersEvent, AbstractXMLEvent, AttributeEvent, CDataEvent, CharactersEvent, CommentEvent, DTDEvent, EndDocumentEvent, EndElementEvent, EntityDeclarationEvent, EntityReferenceEvent, IgnorableSpaceEvent, NamespaceEvent, NotationDeclarationEvent, ProcessingInstructionEvent, StartDocumentEvent, StartElementEvent

public interface ExtendedXMLEvent
extends javax.xml.stream.events.XMLEvent

Extended XMLEvent interface that provides additional functionality.

Version:

$Revision: 1.1 $

Author:

Christian Niles

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(javax.xml.stream.events.XMLEvent event) Determines if this event matches another event, irrespective of document location.
void	writeEvent(javax.xml.stream.XMLStreamWriter writer) Writes the event to the provided XMLStreamWriter.

Methods inherited from interface javax.xml.stream.events.XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Method Detail

matches

boolean matches(javax.xml.stream.events.XMLEvent event)

Determines if this event matches another event, irrespective of document location.

Parameters:

event - The event to match against.

Returns:

true if the two events match, false otherwise.

writeEvent

void writeEvent(javax.xml.stream.XMLStreamWriter writer)
                throws javax.xml.stream.XMLStreamException

Writes the event to the provided XMLStreamWriter.

Parameters:

writer - The destination stream.

Throws:

javax.xml.stream.XMLStreamException - If an error occurs writing to the destination stream.