com.ctc.wstx.ent

Class ExtEntity

java.lang.Object

org.codehaus.stax2.ri.evt.BaseEventImpl

com.ctc.wstx.evt.WEntityDeclaration

com.ctc.wstx.ent.EntityDecl

com.ctc.wstx.ent.ExtEntity

All Implemented Interfaces:

EntityDeclaration, XMLEvent, XMLStreamConstants, org.codehaus.stax2.evt.XMLEvent2

Direct Known Subclasses:

ParsedExtEntity, UnparsedExtEntity

public abstract class ExtEntity
extends EntityDecl

Field Summary

Fields inherited from class com.ctc.wstx.ent.EntityDecl

mDeclaredExternally

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

Constructor and Description
ExtEntity(Location loc, String name, URL ctxt, String pubId, String sysId)

Method Summary

Methods

Modifier and Type	Method and Description
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.
abstract String	getNotationName()
String	getPublicId()
char[]	getReplacementChars()
String	getReplacementText()
int	getReplacementText(Writer w)
String	getSystemId()
boolean	isExternal()
abstract boolean	isParsed()
abstract void	writeEnc(Writer w)

Methods inherited from class com.ctc.wstx.ent.EntityDecl

getBaseURI, getLocation, getName, getReplacementTextLength, markAsExternallyDeclared, wasDeclaredExternally

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

Constructor Detail

ExtEntity

public ExtEntity(Location loc,
         String name,
         URL ctxt,
         String pubId,
         String sysId)

Method Detail

getNotationName

public abstract String getNotationName()

Specified by:

getNotationName in interface EntityDeclaration

Specified by:

getNotationName in class EntityDecl

getPublicId

public String getPublicId()

Specified by:

getPublicId in interface EntityDeclaration

Specified by:

getPublicId in class EntityDecl

getReplacementText

public String getReplacementText()

Specified by:

getReplacementText in interface EntityDeclaration

Specified by:

getReplacementText in class EntityDecl

getReplacementText

public int getReplacementText(Writer w)

Specified by:

getReplacementText in class EntityDecl

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface EntityDeclaration

Specified by:

getSystemId in class EntityDecl

writeEnc

public abstract void writeEnc(Writer w)
                       throws IOException

Specified by:

writeEnc in class EntityDecl

Throws:

IOException

getReplacementChars

public char[] getReplacementChars()

Specified by:

getReplacementChars in class EntityDecl

isExternal

public boolean isExternal()

Specified by:

isExternal in class EntityDecl

isParsed

public abstract boolean isParsed()

Specified by:

isParsed in class EntityDecl

expand

public abstract WstxInputSource expand(WstxInputSource parent,
                     XMLResolver res,
                     ReaderConfig cfg,
                     int xmlVersion)
                                throws IOException,
                                       XMLStreamException

Description copied from class: EntityDecl

Method called to create the new input source through which expansion value of the entity can be read.

Specified by:

expand in class EntityDecl

Throws:

IOException

XMLStreamException