java.lang.Object

com.bea.xml.stream.events.BaseEvent

All Implemented Interfaces:: XMLEvent, Location, XMLStreamConstants

Direct Known Subclasses:: CharactersEvent, DTDEvent, EndDocumentEvent, EntityDeclarationEvent, EntityReferenceEvent, NamedEvent, NotationDeclarationEvent, ProcessingInstructionEvent, StartDocumentEvent

public abstract class BaseEvent extends Object implements XMLEvent, Location

Base event class for events to extend from

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
Constructor Summary

Constructors

Constructor

Description

BaseEvent()

BaseEvent(int type)
Method Summary

Modifier and Type

Method

Description

Characters

asCharacters()

EndElement

asEndElement()

StartElement

asStartElement()

protected abstract void

doWriteAsEncodedUnicode(Writer writer)

Template method to be implemented by sub-classes.

int

getCharacterOffset()

int

getColumnNumber()

int

getEventType()

int

getLineNumber()

Location

getLocation()

String

getLocationURI()

String

getPublicId()

QName

getSchemaType()

String

getSourceName()

String

getSystemId()

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(String uri)

String

toString()

final void

writeAsEncodedUnicode(Writer writer)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- BaseEvent
  
  public BaseEvent()
- BaseEvent
  
  public BaseEvent(int type)
Method Details
- getEventType
  
  public int getEventType()
  
  Specified by:
  
  getEventType in interface XMLEvent
- setEventType
  
  protected void setEventType(int type)
- getTypeAsString
  
  public String getTypeAsString()
- isStartElement
  
  public boolean isStartElement()
  
  Specified by:
  
  isStartElement in interface XMLEvent
- isEndElement
  
  public boolean isEndElement()
  
  Specified by:
  
  isEndElement in interface XMLEvent
- isEntityReference
  
  public boolean isEntityReference()
  
  Specified by:
  
  isEntityReference in interface XMLEvent
- isProcessingInstruction
  
  public boolean isProcessingInstruction()
  
  Specified by:
  
  isProcessingInstruction in interface XMLEvent
- isCharacters
  
  public boolean isCharacters()
  
  Specified by:
  
  isCharacters in interface XMLEvent
- isStartDocument
  
  public boolean isStartDocument()
  
  Specified by:
  
  isStartDocument in interface XMLEvent
- isEndDocument
  
  public boolean isEndDocument()
  
  Specified by:
  
  isEndDocument in interface XMLEvent
- isAttribute
  
  public boolean isAttribute()
  
  Specified by:
  
  isAttribute in interface XMLEvent
- isNamespace
  
  public boolean isNamespace()
  
  Specified by:
  
  isNamespace in interface XMLEvent
- getLocation
  
  public Location getLocation()
  
  Specified by:
  
  getLocation in interface XMLEvent
- getPublicId
  
  public String getPublicId()
  
  Specified by:
  
  getPublicId in interface Location
- getSystemId
  
  public String getSystemId()
  
  Specified by:
  
  getSystemId in interface Location
- getSourceName
  
  public String getSourceName()
- getLineNumber
  
  public int getLineNumber()
  
  Specified by:
  
  getLineNumber in interface Location
- setLineNumber
  
  public void setLineNumber(int line)
- getColumnNumber
  
  public int getColumnNumber()
  
  Specified by:
  
  getColumnNumber in interface Location
- setColumnNumber
  
  public void setColumnNumber(int col)
- getCharacterOffset
  
  public int getCharacterOffset()
  
  Specified by:
  
  getCharacterOffset in interface Location
- setCharacterOffset
  
  public void setCharacterOffset(int c)
- getLocationURI
  
  public String getLocationURI()
- setLocationURI
  
  public void setLocationURI(String uri)
- asStartElement
  
  public StartElement asStartElement()
  
  Specified by:
  
  asStartElement in interface XMLEvent
- asEndElement
  
  public EndElement asEndElement()
  
  Specified by:
  
  asEndElement in interface XMLEvent
- asCharacters
  
  public Characters asCharacters()
  
  Specified by:
  
  asCharacters in interface XMLEvent
- recycle
  
  public void recycle()
- getSchemaType
  
  public QName getSchemaType()
  
  Specified by:
  
  getSchemaType in interface XMLEvent
- writeAsEncodedUnicode
  
  public final void writeAsEncodedUnicode(Writer writer) throws XMLStreamException
  
  Specified by:
  
  writeAsEncodedUnicode in interface XMLEvent
  
  Throws:
  
  XMLStreamException
- doWriteAsEncodedUnicode
  
  protected abstract void doWriteAsEncodedUnicode(Writer writer) throws IOException, XMLStreamException
  
  Template method to be implemented by sub-classes.
  
  Throws:
  
  IOException
  
  XMLStreamException
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class BaseEvent

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

BaseEvent

BaseEvent

Method Details

getEventType

setEventType

getTypeAsString

isStartElement

isEndElement

isEntityReference

isProcessingInstruction

isCharacters

isStartDocument

isEndDocument

isAttribute

isNamespace

getLocation

getPublicId

getSystemId

getSourceName

getLineNumber

setLineNumber

getColumnNumber

setColumnNumber

getCharacterOffset

setCharacterOffset

getLocationURI

setLocationURI

asStartElement

asEndElement

asCharacters

recycle

getSchemaType

writeAsEncodedUnicode

doWriteAsEncodedUnicode

toString