Package com.bea.xml.stream.events
Class BaseEvent
- java.lang.Object
-
- com.bea.xml.stream.events.BaseEvent
-
- All Implemented Interfaces:
javax.xml.stream.events.XMLEvent
,javax.xml.stream.Location
,javax.xml.stream.XMLStreamConstants
- Direct Known Subclasses:
CharactersEvent
,DTDEvent
,EndDocumentEvent
,EntityDeclarationEvent
,EntityReferenceEvent
,NamedEvent
,NotationDeclarationEvent
,ProcessingInstructionEvent
,StartDocumentEvent
public abstract class BaseEvent extends java.lang.Object implements javax.xml.stream.events.XMLEvent, javax.xml.stream.Location
Base event class for events to extend from
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description javax.xml.stream.events.Characters
asCharacters()
javax.xml.stream.events.EndElement
asEndElement()
javax.xml.stream.events.StartElement
asStartElement()
protected abstract void
doWriteAsEncodedUnicode(java.io.Writer writer)
Template method to be implemented by sub-classes.int
getCharacterOffset()
int
getColumnNumber()
int
getEventType()
int
getLineNumber()
javax.xml.stream.Location
getLocation()
java.lang.String
getLocationURI()
java.lang.String
getPublicId()
javax.xml.namespace.QName
getSchemaType()
java.lang.String
getSourceName()
java.lang.String
getSystemId()
java.lang.String
getTypeAsString()
boolean
isAttribute()
boolean
isCharacters()
boolean
isEndDocument()
boolean
isEndElement()
boolean
isEntityReference()
boolean
isNamespace()
boolean
isProcessingInstruction()
boolean
isStartDocument()
boolean
isStartElement()
void
recycle()
void
setCharacterOffset(int c)
void
setColumnNumber(int col)
protected void
setEventType(int type)
void
setLineNumber(int line)
void
setLocationURI(java.lang.String uri)
java.lang.String
toString()
void
writeAsEncodedUnicode(java.io.Writer writer)
-
-
-
Method Detail
-
getEventType
public int getEventType()
- Specified by:
getEventType
in interfacejavax.xml.stream.events.XMLEvent
-
setEventType
protected void setEventType(int type)
-
getTypeAsString
public java.lang.String getTypeAsString()
-
isStartElement
public boolean isStartElement()
- Specified by:
isStartElement
in interfacejavax.xml.stream.events.XMLEvent
-
isEndElement
public boolean isEndElement()
- Specified by:
isEndElement
in interfacejavax.xml.stream.events.XMLEvent
-
isEntityReference
public boolean isEntityReference()
- Specified by:
isEntityReference
in interfacejavax.xml.stream.events.XMLEvent
-
isProcessingInstruction
public boolean isProcessingInstruction()
- Specified by:
isProcessingInstruction
in interfacejavax.xml.stream.events.XMLEvent
-
isCharacters
public boolean isCharacters()
- Specified by:
isCharacters
in interfacejavax.xml.stream.events.XMLEvent
-
isStartDocument
public boolean isStartDocument()
- Specified by:
isStartDocument
in interfacejavax.xml.stream.events.XMLEvent
-
isEndDocument
public boolean isEndDocument()
- Specified by:
isEndDocument
in interfacejavax.xml.stream.events.XMLEvent
-
isAttribute
public boolean isAttribute()
- Specified by:
isAttribute
in interfacejavax.xml.stream.events.XMLEvent
-
isNamespace
public boolean isNamespace()
- Specified by:
isNamespace
in interfacejavax.xml.stream.events.XMLEvent
-
getLocation
public javax.xml.stream.Location getLocation()
- Specified by:
getLocation
in interfacejavax.xml.stream.events.XMLEvent
-
getPublicId
public java.lang.String getPublicId()
- Specified by:
getPublicId
in interfacejavax.xml.stream.Location
-
getSystemId
public java.lang.String getSystemId()
- Specified by:
getSystemId
in interfacejavax.xml.stream.Location
-
getSourceName
public java.lang.String getSourceName()
-
getLineNumber
public int getLineNumber()
- Specified by:
getLineNumber
in interfacejavax.xml.stream.Location
-
setLineNumber
public void setLineNumber(int line)
-
getColumnNumber
public int getColumnNumber()
- Specified by:
getColumnNumber
in interfacejavax.xml.stream.Location
-
setColumnNumber
public void setColumnNumber(int col)
-
getCharacterOffset
public int getCharacterOffset()
- Specified by:
getCharacterOffset
in interfacejavax.xml.stream.Location
-
setCharacterOffset
public void setCharacterOffset(int c)
-
getLocationURI
public java.lang.String getLocationURI()
-
setLocationURI
public void setLocationURI(java.lang.String uri)
-
asStartElement
public javax.xml.stream.events.StartElement asStartElement()
- Specified by:
asStartElement
in interfacejavax.xml.stream.events.XMLEvent
-
asEndElement
public javax.xml.stream.events.EndElement asEndElement()
- Specified by:
asEndElement
in interfacejavax.xml.stream.events.XMLEvent
-
asCharacters
public javax.xml.stream.events.Characters asCharacters()
- Specified by:
asCharacters
in interfacejavax.xml.stream.events.XMLEvent
-
recycle
public void recycle()
-
getSchemaType
public javax.xml.namespace.QName getSchemaType()
- Specified by:
getSchemaType
in interfacejavax.xml.stream.events.XMLEvent
-
writeAsEncodedUnicode
public final void writeAsEncodedUnicode(java.io.Writer writer) throws javax.xml.stream.XMLStreamException
- Specified by:
writeAsEncodedUnicode
in interfacejavax.xml.stream.events.XMLEvent
- Throws:
javax.xml.stream.XMLStreamException
-
doWriteAsEncodedUnicode
protected abstract void doWriteAsEncodedUnicode(java.io.Writer writer) throws java.io.IOException, javax.xml.stream.XMLStreamException
Template method to be implemented by sub-classes.- Throws:
java.io.IOException
javax.xml.stream.XMLStreamException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-