Package com.ctc.wstx.ent
Class EntityDecl
java.lang.Object
org.codehaus.stax2.ri.evt.BaseEventImpl
com.ctc.wstx.evt.WEntityDeclaration
com.ctc.wstx.ent.EntityDecl
- All Implemented Interfaces:
EntityDeclaration
,XMLEvent
,XMLStreamConstants
,org.codehaus.stax2.evt.XMLEvent2
Abstract base class for various entity declarations DTD reader
has parsed from DTD subsets.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final URL
Context that is to be used to resolve references encountered from expanded contents of this entity.protected boolean
Flag that can be set to indicate that the declaration was in the external DTD subset.(package private) final String
Name/id of the entity used to reference it.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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract 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.final String
final String
getName()
abstract String
abstract String
abstract char[]
abstract String
abstract int
final int
abstract String
abstract boolean
abstract boolean
isParsed()
void
boolean
abstract void
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, getLocation, 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, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement
-
Field Details
-
mName
Name/id of the entity used to reference it. -
mContext
Context that is to be used to resolve references encountered from expanded contents of this entity. -
mDeclaredExternally
protected boolean mDeclaredExternallyFlag that can be set to indicate that the declaration was in the external DTD subset. Default is false.
-
-
Constructor Details
-
EntityDecl
-
-
Method Details
-
markAsExternallyDeclared
public void markAsExternallyDeclared() -
getBaseURI
- Specified by:
getBaseURI
in interfaceEntityDeclaration
- Specified by:
getBaseURI
in classWEntityDeclaration
-
getName
- Specified by:
getName
in interfaceEntityDeclaration
- Specified by:
getName
in classWEntityDeclaration
-
getNotationName
- Specified by:
getNotationName
in interfaceEntityDeclaration
- Specified by:
getNotationName
in classWEntityDeclaration
-
getPublicId
- Specified by:
getPublicId
in interfaceEntityDeclaration
- Specified by:
getPublicId
in classWEntityDeclaration
-
getReplacementText
- Specified by:
getReplacementText
in interfaceEntityDeclaration
- Specified by:
getReplacementText
in classWEntityDeclaration
-
getReplacementText
- Throws:
IOException
-
getSystemId
- Specified by:
getSystemId
in interfaceEntityDeclaration
- Specified by:
getSystemId
in classWEntityDeclaration
-
wasDeclaredExternally
public boolean wasDeclaredExternally()- Returns:
- True, if the declaration occured in the external DTD subset; false if not (internal subset, custom declaration)
-
writeEnc
- Specified by:
writeEnc
in classWEntityDeclaration
- 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
-