Class EntityDeclarationEvent

java.lang.Object

com.bea.xml.stream.events.BaseEvent

com.bea.xml.stream.events.EntityDeclarationEvent

All Implemented Interfaces:

EntityDeclaration, XMLEvent, Location, XMLStreamConstants

public class EntityDeclarationEvent
extends BaseEvent
implements EntityDeclaration

Simple implementation of EntityDeclaration. Since no external or unparsed entities are supported (yet?), this is quite simplistic implementation.

Author:

Tatu Saloranta

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name
protected final String	replacementText

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
EntityDeclarationEvent(String name, String replText)

Method Summary

Modifier and Type	Method	Description
protected void	doWriteAsEncodedUnicode(Writer writer)	Template method to be implemented by sub-classes.
String	getBaseURI()	Get the base URI for this reference or null if this information is not available
String	getName()	The entity's name
String	getNotationName()	The name of the associated notation.
String	getPublicId()	Returns the public ID of the XML
String	getReplacementText()	The replacement text of the entity.
String	getSystemId()	Returns the system ID of the XML

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, toString, 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

Field Details

name

protected final String name

replacementText

protected final String replacementText

Constructor Details

EntityDeclarationEvent

public EntityDeclarationEvent(String name,
 String replText)

Method Details

getReplacementText

public String getReplacementText()

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

The replacement text of the entity. This method will only return non-null if this is an internal entity.

Specified by:

getReplacementText in interface EntityDeclaration

Returns:

null or the replacment text

getName

public String getName()

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

The entity's name

Specified by:

getName in interface EntityDeclaration

Returns:

the name, may not be null

getBaseURI

public String getBaseURI()

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

Get the base URI for this reference or null if this information is not available

Specified by:

getBaseURI in interface EntityDeclaration

Returns:

the base URI or null

getPublicId

public String getPublicId()

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

Returns the public ID of the XML

Specified by:

getPublicId in interface EntityDeclaration

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 EntityDeclaration

Specified by:

getSystemId in interface Location

Overrides:

getSystemId in class BaseEvent

Returns:

the system ID, or null if not available

getNotationName

public String getNotationName()

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

The name of the associated notation.

Specified by:

getNotationName in interface EntityDeclaration

Returns:

the notation name

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