com.ctc.wstx.ent
Class EntityDecl

java.lang.Object
  extended by org.codehaus.stax2.ri.evt.BaseEventImpl
      extended by com.ctc.wstx.evt.WEntityDeclaration
          extended by com.ctc.wstx.ent.EntityDecl
All Implemented Interfaces:
EntityDeclaration, XMLEvent, XMLStreamConstants, XMLEvent2
Direct Known Subclasses:
ExtEntity, IntEntity

public abstract class EntityDecl
extends WEntityDeclaration

Abstract base class for various entity declarations DTD reader has parsed from DTD subsets.


Field Summary
protected  boolean mDeclaredExternally
          Flag that can be set to indicate that the declaration was in the external DTD subset.
 
Fields inherited from class org.codehaus.stax2.ri.evt.BaseEventImpl
mLocation
 
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
EntityDecl(Location loc, String name, URL ctxt)
           
 
Method Summary
abstract  WstxInputSource expand(WstxInputSource parent, XMLResolver res, ReaderConfig cfg, int xmlVersion)
          Method called to create the new input source through which expansion value of the entity can be read.
 String getBaseURI()
           
 Location getLocation()
           
 String getName()
           
abstract  String getNotationName()
           
abstract  String getPublicId()
           
abstract  char[] getReplacementChars()
           
abstract  String getReplacementText()
           
abstract  int getReplacementText(Writer w)
           
 int getReplacementTextLength()
           
abstract  String getSystemId()
           
abstract  boolean isExternal()
           
abstract  boolean isParsed()
           
 void markAsExternallyDeclared()
           
 boolean wasDeclaredExternally()
           
abstract  void writeEnc(Writer w)
           
 
Methods inherited from class com.ctc.wstx.evt.WEntityDeclaration
equals, getEventType, hashCode, writeAsEncodedUnicode, writeUsing
 
Methods inherited from class org.codehaus.stax2.ri.evt.BaseEventImpl
addHash, asCharacters, asEndElement, asStartElement, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, iteratedEquals, stringsWithNullsEqual, throwFromIOE, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.stream.events.XMLEvent
asCharacters, asEndElement, asStartElement, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement
 

Field Detail

mDeclaredExternally

protected boolean mDeclaredExternally
Flag that can be set to indicate that the declaration was in the external DTD subset. Default is false.

Constructor Detail

EntityDecl

public EntityDecl(Location loc,
                  String name,
                  URL ctxt)
Method Detail

markAsExternallyDeclared

public void markAsExternallyDeclared()

getBaseURI

public final String getBaseURI()
Specified by:
getBaseURI in interface EntityDeclaration
Specified by:
getBaseURI in class WEntityDeclaration

getName

public final String getName()
Specified by:
getName in interface EntityDeclaration
Specified by:
getName in class WEntityDeclaration

getLocation

public final Location getLocation()
Specified by:
getLocation in interface XMLEvent
Overrides:
getLocation in class BaseEventImpl

getNotationName

public abstract String getNotationName()
Specified by:
getNotationName in interface EntityDeclaration
Specified by:
getNotationName in class WEntityDeclaration

getPublicId

public abstract String getPublicId()
Specified by:
getPublicId in interface EntityDeclaration
Specified by:
getPublicId in class WEntityDeclaration

getReplacementText

public abstract String getReplacementText()
Specified by:
getReplacementText in interface EntityDeclaration
Specified by:
getReplacementText in class WEntityDeclaration

getReplacementText

public abstract int getReplacementText(Writer w)
                                throws IOException
Throws:
IOException

getSystemId

public abstract String getSystemId()
Specified by:
getSystemId in interface EntityDeclaration
Specified by:
getSystemId in class WEntityDeclaration

wasDeclaredExternally

public boolean wasDeclaredExternally()
Returns:
True, if the declaration occured in the external DTD subset; false if not (internal subset, custom declaration)

writeEnc

public abstract void writeEnc(Writer w)
                       throws IOException
Specified by:
writeEnc in class WEntityDeclaration
Throws:
IOException

getReplacementChars

public abstract char[] getReplacementChars()

getReplacementTextLength

public final int getReplacementTextLength()

isExternal

public abstract boolean isExternal()

isParsed

public abstract boolean isParsed()

expand

public abstract WstxInputSource expand(WstxInputSource parent,
                                       XMLResolver res,
                                       ReaderConfig cfg,
                                       int xmlVersion)
                                throws IOException,
                                       XMLStreamException
Method called to create the new input source through which expansion value of the entity can be read.

Throws:
IOException
XMLStreamException