com.bea.xml.stream.events
Class EntityReferenceEvent

java.lang.Object
  com.bea.xml.stream.events.BaseEvent
      com.bea.xml.stream.events.EntityReferenceEvent

All Implemented Interfaces:

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

public class EntityReferenceEvent
extends BaseEvent
implements javax.xml.stream.events.EntityReference

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

EntityReferenceEvent()

EntityReferenceEvent(java.lang.String name, javax.xml.stream.events.EntityDeclaration ed)

Method Summary

protected void	doWriteAsEncodedUnicode(java.io.Writer writer) Template method to be implemented by sub-classes.
java.lang.String	getBaseURI()
javax.xml.stream.events.EntityDeclaration	getDeclaration() Return the declaration of this entity.
java.lang.String	getName() The name of the entity
java.lang.String	getPublicId() Returns the public ID of the XML
java.lang.String	getReplacementText()
java.lang.String	getSystemId() Returns the system ID of the XML
protected void	init()
void	setName(java.lang.String name)
void	setReplacementText(java.lang.String text)
java.lang.String	toString() toString() overridden to output more information than what the default implementation from base event class outputs.

Methods inherited from class com.bea.xml.stream.events.BaseEvent

asCharacters, asEndElement, asStartElement, getCharacterOffset, getColumnNumber, getEventType, getLineNumber, getLocation, getLocationURI, getSchemaType, getSourceName, getTypeAsString, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, recycle, setCharacterOffset, setColumnNumber, setEventType, setLineNumber, setLocationURI, writeAsEncodedUnicode

Methods inherited from class java.lang.Object

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

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

Constructor Detail

EntityReferenceEvent

public EntityReferenceEvent()

EntityReferenceEvent

public EntityReferenceEvent(java.lang.String name,
                            javax.xml.stream.events.EntityDeclaration ed)

Method Detail

getReplacementText

public java.lang.String getReplacementText()

getName

public java.lang.String getName()

Description copied from interface: javax.xml.stream.events.EntityReference

The name of the entity

Specified by:

getName in interface javax.xml.stream.events.EntityReference

Returns:

the entity's name, may not be null

setName

public void setName(java.lang.String name)

setReplacementText

public void setReplacementText(java.lang.String text)

getBaseURI

public java.lang.String getBaseURI()

getPublicId

public java.lang.String getPublicId()

Description copied from interface: javax.xml.stream.Location

Returns the public ID of the XML

Specified by:

getPublicId in interface javax.xml.stream.Location

Overrides:

getPublicId in class BaseEvent

Returns:

the public ID, or null if not available

getSystemId

public java.lang.String getSystemId()

Description copied from interface: javax.xml.stream.Location

Returns the system ID of the XML

Specified by:

getSystemId in interface javax.xml.stream.Location

Overrides:

getSystemId in class BaseEvent

Returns:

the system ID, or null if not available

getDeclaration

public javax.xml.stream.events.EntityDeclaration getDeclaration()

Description copied from interface: javax.xml.stream.events.EntityReference

Return the declaration of this entity.

Specified by:

getDeclaration in interface javax.xml.stream.events.EntityReference

init

protected void init()

doWriteAsEncodedUnicode

protected void doWriteAsEncodedUnicode(java.io.Writer writer)
                                throws java.io.IOException

Description copied from class: BaseEvent

Template method to be implemented by sub-classes.

Specified by:

doWriteAsEncodedUnicode in class BaseEvent

Throws:

java.io.IOException

toString

public java.lang.String toString()

toString() overridden to output more information than what the default implementation from base event class outputs.

Overrides:

toString in class BaseEvent