javanet.staxutils.events

Class AbstractXMLEvent

java.lang.Object

javanet.staxutils.events.AbstractXMLEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ExtendedXMLEvent, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

Direct Known Subclasses:

AbstractCharactersEvent, AttributeEvent, CommentEvent, DTDEvent, EndDocumentEvent, EndElementEvent, EntityDeclarationEvent, EntityReferenceEvent, NotationDeclarationEvent, ProcessingInstructionEvent, StartDocumentEvent, StartElementEvent

public abstract class AbstractXMLEvent
extends java.lang.Object
implements ExtendedXMLEvent, java.io.Serializable, java.lang.Cloneable

Abstract base class for XMLEvent implementations.

Version:

$Revision: 1.3 $

Author:

Christian Niles

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.stream.Location	location The event location.
protected javax.xml.namespace.QName	schemaType The schema type.

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

Constructor Summary

Constructors

Constructor and Description
AbstractXMLEvent()
AbstractXMLEvent(javax.xml.stream.Location location)
AbstractXMLEvent(javax.xml.stream.Location location, javax.xml.namespace.QName schemaType)
AbstractXMLEvent(javax.xml.stream.events.XMLEvent that)

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.events.Characters	asCharacters()
javax.xml.stream.events.EndElement	asEndElement()
javax.xml.stream.events.StartElement	asStartElement()
java.lang.Object	clone()
javax.xml.stream.Location	getLocation()
javax.xml.namespace.QName	getSchemaType()
boolean	isAttribute()
boolean	isCharacters()
boolean	isEndDocument()
boolean	isEndElement()
boolean	isEntityReference()
boolean	isNamespace()
boolean	isProcessingInstruction()
boolean	isStartDocument()
boolean	isStartElement()
boolean	matches(javax.xml.stream.events.XMLEvent event) Determines if this event matches another event, irrespective of document location.
java.lang.String	toString()
void	writeAsEncodedUnicode(java.io.Writer writer)
void	writeEvent(javax.xml.stream.XMLStreamWriter writer) Writes the event to the provided XMLStreamWriter.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getEventType

Field Detail

location

protected javax.xml.stream.Location location

The event location.

schemaType

protected javax.xml.namespace.QName schemaType

The schema type.

Constructor Detail

AbstractXMLEvent

public AbstractXMLEvent()

AbstractXMLEvent

public AbstractXMLEvent(javax.xml.stream.Location location)

AbstractXMLEvent

public AbstractXMLEvent(javax.xml.stream.Location location,
                        javax.xml.namespace.QName schemaType)

AbstractXMLEvent

public AbstractXMLEvent(javax.xml.stream.events.XMLEvent that)

Method Detail

getLocation

public javax.xml.stream.Location getLocation()

Specified by:

getLocation in interface javax.xml.stream.events.XMLEvent

getSchemaType

public javax.xml.namespace.QName getSchemaType()

Specified by:

getSchemaType in interface javax.xml.stream.events.XMLEvent

asCharacters

public javax.xml.stream.events.Characters asCharacters()

Specified by:

asCharacters in interface javax.xml.stream.events.XMLEvent

asEndElement

public javax.xml.stream.events.EndElement asEndElement()

Specified by:

asEndElement in interface javax.xml.stream.events.XMLEvent

asStartElement

public javax.xml.stream.events.StartElement asStartElement()

Specified by:

asStartElement in interface javax.xml.stream.events.XMLEvent

isAttribute

public boolean isAttribute()

Specified by:

isAttribute in interface javax.xml.stream.events.XMLEvent

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface javax.xml.stream.events.XMLEvent

isEndDocument

public boolean isEndDocument()

Specified by:

isEndDocument in interface javax.xml.stream.events.XMLEvent

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface javax.xml.stream.events.XMLEvent

isEntityReference

public boolean isEntityReference()

Specified by:

isEntityReference in interface javax.xml.stream.events.XMLEvent

isNamespace

public boolean isNamespace()

Specified by:

isNamespace in interface javax.xml.stream.events.XMLEvent

isProcessingInstruction

public boolean isProcessingInstruction()

Specified by:

isProcessingInstruction in interface javax.xml.stream.events.XMLEvent

isStartDocument

public boolean isStartDocument()

Specified by:

isStartDocument in interface javax.xml.stream.events.XMLEvent

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface javax.xml.stream.events.XMLEvent

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

matches

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

Description copied from interface: ExtendedXMLEvent

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

Specified by:

matches in interface ExtendedXMLEvent

Parameters:

event - The event to match against.

Returns:

true if the two events match, false otherwise.

writeEvent

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

Description copied from interface: ExtendedXMLEvent

Writes the event to the provided XMLStreamWriter.

Specified by:

writeEvent in interface ExtendedXMLEvent

Parameters:

writer - The destination stream.

Throws:

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

writeAsEncodedUnicode

public void writeAsEncodedUnicode(java.io.Writer writer)
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeAsEncodedUnicode in interface javax.xml.stream.events.XMLEvent

Throws:

javax.xml.stream.XMLStreamException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object