com.bea.xml.stream.events
Class EntityDeclarationEvent

java.lang.Object
  extended by com.bea.xml.stream.events.BaseEvent
      extended by com.bea.xml.stream.events.EntityDeclarationEvent
All Implemented Interfaces:
javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.Location, javax.xml.stream.XMLStreamConstants

public class EntityDeclarationEvent
extends BaseEvent
implements javax.xml.stream.events.EntityDeclaration

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

Author:
Tatu Saloranta

Field Summary
protected  java.lang.String name
           
protected  java.lang.String replacementText
           
 
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
EntityDeclarationEvent(java.lang.String name, java.lang.String replText)
           
 
Method Summary
protected  void doWriteAsEncodedUnicode(java.io.Writer writer)
          Template method to be implemented by sub-classes.
 java.lang.String getBaseURI()
          Get the base URI for this reference or null if this information is not available
 java.lang.String getName()
          The entity's name
 java.lang.String getNotationName()
          The name of the associated notation.
 java.lang.String getPublicId()
          Returns the public ID of the XML
 java.lang.String getReplacementText()
          The replacement text of the entity.
 java.lang.String getSystemId()
          Returns the system ID of the XML
 
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, toString, 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
 

Field Detail

name

protected final java.lang.String name

replacementText

protected final java.lang.String replacementText
Constructor Detail

EntityDeclarationEvent

public EntityDeclarationEvent(java.lang.String name,
                              java.lang.String replText)
Method Detail

getReplacementText

public java.lang.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 javax.xml.stream.events.EntityDeclaration
Returns:
null or the replacment text

getName

public java.lang.String getName()
Description copied from interface: javax.xml.stream.events.EntityDeclaration
The entity's name

Specified by:
getName in interface javax.xml.stream.events.EntityDeclaration
Returns:
the name, may not be null

getBaseURI

public java.lang.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 javax.xml.stream.events.EntityDeclaration
Returns:
the base URI or null

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.events.EntityDeclaration
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.events.EntityDeclaration
Specified by:
getSystemId in interface javax.xml.stream.Location
Overrides:
getSystemId in class BaseEvent
Returns:
the system ID, or null if not available

getNotationName

public java.lang.String getNotationName()
Description copied from interface: javax.xml.stream.events.EntityDeclaration
The name of the associated notation.

Specified by:
getNotationName in interface javax.xml.stream.events.EntityDeclaration
Returns:
the notation name

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