Package com.ctc.wstx.ent

Class IntEntity

java.lang.Object

org.codehaus.stax2.ri.evt.BaseEventImpl

com.ctc.wstx.evt.WEntityDeclaration

com.ctc.wstx.ent.EntityDecl

com.ctc.wstx.ent.IntEntity

All Implemented Interfaces:

EntityDeclaration, XMLEvent, XMLStreamConstants, XMLEvent2

public class IntEntity
extends EntityDecl

Field Summary

Fields

Modifier and Type	Field	Description
protected Location	mContentLocation	Location where entity content definition started; points to the starting/opening quote for internal entities.

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	Description
IntEntity(Location loc, String name, URL ctxt, char[] repl, Location defLoc)

Method Summary

Modifier and Type	Method	Description
static IntEntity	create(String id, char[] val)
static IntEntity	create(String id, String repl)
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	getNotationName()
String	getPublicId()
char[]	getReplacementChars()	Gives raw access to replacement text data...
String	getReplacementText()
int	getReplacementText(Writer w)
String	getSystemId()
boolean	isExternal()
boolean	isParsed()
void	writeEnc(Writer w)

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

getBaseURI, 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, 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 Detail

mContentLocation

protected final Location mContentLocation

Location where entity content definition started; points to the starting/opening quote for internal entities.

Constructor Detail

IntEntity

public IntEntity(Location loc,
                 String name,
                 URL ctxt,
                 char[] repl,
                 Location defLoc)

Method Detail

create

public static IntEntity create(String id,
                               String repl)

create

public static IntEntity create(String id,
                               char[] val)

getNotationName

public 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)
                       throws IOException

Specified by:

getReplacementText in class EntityDecl

Throws:

IOException

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface EntityDeclaration

Specified by:

getSystemId in class EntityDecl

writeEnc

public void writeEnc(Writer w)
              throws IOException

Specified by:

writeEnc in class EntityDecl

Throws:

IOException

getReplacementChars

public char[] getReplacementChars()

Gives raw access to replacement text data...

Note: this is not really safe, as caller can modify the array, but since this method is thought to provide fast access, let's avoid making copy here.

Specified by:

getReplacementChars in class EntityDecl

isExternal

public boolean isExternal()

Specified by:

isExternal in class EntityDecl

isParsed

public boolean isParsed()

Specified by:

isParsed in class EntityDecl

expand

public WstxInputSource expand(WstxInputSource parent,
                              XMLResolver res,
                              ReaderConfig cfg,
                              int xmlVersion)

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