Class EntityReferenceEvent

java.lang.Object

com.bea.xml.stream.events.BaseEvent

com.bea.xml.stream.events.EntityReferenceEvent

All Implemented Interfaces:

EntityReference, XMLEvent, Location, XMLStreamConstants

public class EntityReferenceEvent
extends BaseEvent
implements EntityReference

Field Summary

Fields inherited from interface 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
EntityReferenceEvent()
EntityReferenceEvent(String name, EntityDeclaration ed)

Method Summary

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

Methods inherited from class 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 Object

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

Methods inherited from interface XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Constructor Details

EntityReferenceEvent

public EntityReferenceEvent()

EntityReferenceEvent

public EntityReferenceEvent(String name,
 EntityDeclaration ed)

Method Details

getReplacementText

public String getReplacementText()

getName

public String getName()

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

The name of the entity

Specified by:

getName in interface EntityReference

Returns:

the entity's name, may not be null

setName

public void setName(String name)

setReplacementText

public void setReplacementText(String text)

getBaseURI

public String getBaseURI()

getPublicId

public String getPublicId()

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

Returns the public ID of the XML

Specified by:

getPublicId in interface Location

Overrides:

getPublicId in class BaseEvent

Returns:

the public ID, or null if not available

getSystemId

public String getSystemId()

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

Returns the system ID of the XML

Specified by:

getSystemId in interface Location

Overrides:

getSystemId in class BaseEvent

Returns:

the system ID, or null if not available

getDeclaration

public EntityDeclaration getDeclaration()

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

Return the declaration of this entity.

Specified by:

getDeclaration in interface EntityReference

init

protected void init()

doWriteAsEncodedUnicode

protected void doWriteAsEncodedUnicode(Writer writer)
                                throws IOException

Description copied from class: BaseEvent

Template method to be implemented by sub-classes.

Specified by:

doWriteAsEncodedUnicode in class BaseEvent

Throws:

IOException

toString

public String toString()

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

Overrides:

toString in class BaseEvent