org.codehaus.stax2.ri.evt

Class BaseEventImpl

java.lang.Object

org.codehaus.stax2.ri.evt.BaseEventImpl

All Implemented Interfaces:

XMLEvent, XMLStreamConstants, XMLEvent2

Direct Known Subclasses:

AttributeEventImpl, CharactersEventImpl, CommentEventImpl, DTDEventImpl, EndDocumentEventImpl, EndElementEventImpl, EntityDeclarationEventImpl, EntityReferenceEventImpl, NotationDeclarationEventImpl, ProcInstrEventImpl, StartDocumentEventImpl, StartElementEventImpl

public abstract class BaseEventImpl
extends Object
implements XMLEvent2

This abstract base class implements common functionality for Stax2 reference implementation's event API part.

Author:

Tatu Saloranta

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	mLocation Deprecated. Call getLocation() instead.

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

Modifier	Constructor and Description
protected	BaseEventImpl(Location loc)

Method Summary

Methods

Modifier and Type	Method and Description
protected static int	addHash(Iterator<?> it, int baseHash)
Characters	asCharacters()
EndElement	asEndElement()
StartElement	asStartElement()
abstract boolean	equals(Object o) Declared abstract to force redefinition by sub-classes
abstract int	getEventType()
Location	getLocation()
QName	getSchemaType()
abstract int	hashCode() Declared abstract to force redefinition by sub-classes
boolean	isAttribute()
boolean	isCharacters()
boolean	isEndDocument()
boolean	isEndElement()
boolean	isEntityReference()
boolean	isNamespace()
boolean	isProcessingInstruction()
boolean	isStartDocument()
boolean	isStartElement()
protected static boolean	iteratedEquals(Iterator<?> it1, Iterator<?> it2)
protected static boolean	stringsWithNullsEqual(String s1, String s2) Comparison method that will consider null Strings to be equivalent to empty Strings for comparison purposes; and compare equality with that caveat.
protected void	throwFromIOE(IOException ioe)
String	toString()
abstract void	writeAsEncodedUnicode(Writer w)
abstract void	writeUsing(XMLStreamWriter2 w)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

mLocation

@Deprecated
protected final Location mLocation

Deprecated. Call getLocation() instead.

Location where token started; exact definition may depends on event type.

TODO: remove direct dependencies to this by sub-classes; rename

Constructor Detail

BaseEventImpl

protected BaseEventImpl(Location loc)

Method Detail

asCharacters

public Characters asCharacters()

Specified by:

asCharacters in interface XMLEvent

asEndElement

public EndElement asEndElement()

Specified by:

asEndElement in interface XMLEvent

asStartElement

public StartElement asStartElement()

Specified by:

asStartElement in interface XMLEvent

getEventType

public abstract int getEventType()

Specified by:

getEventType in interface XMLEvent

getLocation

public Location getLocation()

Specified by:

getLocation in interface XMLEvent

getSchemaType

public QName getSchemaType()

Specified by:

getSchemaType in interface XMLEvent

isAttribute

public boolean isAttribute()

Specified by:

isAttribute in interface XMLEvent

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface XMLEvent

isEndDocument

public boolean isEndDocument()

Specified by:

isEndDocument in interface XMLEvent

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface XMLEvent

isEntityReference

public boolean isEntityReference()

Specified by:

isEntityReference in interface XMLEvent

isNamespace

public boolean isNamespace()

Specified by:

isNamespace in interface XMLEvent

isProcessingInstruction

public boolean isProcessingInstruction()

Specified by:

isProcessingInstruction in interface XMLEvent

isStartDocument

public boolean isStartDocument()

Specified by:

isStartDocument in interface XMLEvent

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface XMLEvent

writeAsEncodedUnicode

public abstract void writeAsEncodedUnicode(Writer w)
                                    throws XMLStreamException

Specified by:

writeAsEncodedUnicode in interface XMLEvent

Throws:

XMLStreamException

writeUsing

public abstract void writeUsing(XMLStreamWriter2 w)
                         throws XMLStreamException

Specified by:

writeUsing in interface XMLEvent2

Throws:

XMLStreamException

equals

public abstract boolean equals(Object o)

Declared abstract to force redefinition by sub-classes

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Declared abstract to force redefinition by sub-classes

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

throwFromIOE

protected void throwFromIOE(IOException ioe)
                     throws XMLStreamException

Throws:

XMLStreamException

stringsWithNullsEqual

protected static boolean stringsWithNullsEqual(String s1,
                            String s2)

Comparison method that will consider null Strings to be equivalent to empty Strings for comparison purposes; and compare equality with that caveat.

iteratedEquals

protected static boolean iteratedEquals(Iterator<?> it1,
                     Iterator<?> it2)

addHash

protected static int addHash(Iterator<?> it,
          int baseHash)