com.ctc.wstx.ent
Class IntEntity

java.lang.Object
  extended by com.ctc.wstx.evt.WEvent
      extended by com.ctc.wstx.evt.WEntityDeclaration
          extended by com.ctc.wstx.ent.EntityDecl
              extended by com.ctc.wstx.ent.IntEntity
All Implemented Interfaces:
javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants, XMLEvent2

public class IntEntity
extends EntityDecl


Field Summary
protected  javax.xml.stream.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 com.ctc.wstx.evt.WEvent
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
IntEntity(javax.xml.stream.Location loc, java.lang.String name, java.net.URL ctxt, char[] repl, javax.xml.stream.Location defLoc)
           
 
Method Summary
static IntEntity create(java.lang.String id, char[] val)
           
static IntEntity create(java.lang.String id, java.lang.String repl)
           
 WstxInputSource expand(WstxInputSource parent, javax.xml.stream.XMLResolver res, ReaderConfig cfg, int xmlVersion)
          Method called to create the new input source through which expansion value of the entity can be read.
 java.lang.String getNotationName()
           
 java.lang.String getPublicId()
           
 char[] getReplacementChars()
          Gives raw access to replacement text data...
 java.lang.String getReplacementText()
           
 int getReplacementText(java.io.Writer w)
           
 java.lang.String getSystemId()
           
 boolean isExternal()
           
 boolean isParsed()
           
 void writeEnc(java.io.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
getEventType, writeAsEncodedUnicode, writeUsing
 
Methods inherited from class com.ctc.wstx.evt.WEvent
asCharacters, asEndElement, asStartElement, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, throwFromIOE, toString
 
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, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement
 

Field Detail

mContentLocation

protected final javax.xml.stream.Location mContentLocation
Location where entity content definition started; points to the starting/opening quote for internal entities.

Constructor Detail

IntEntity

public IntEntity(javax.xml.stream.Location loc,
                 java.lang.String name,
                 java.net.URL ctxt,
                 char[] repl,
                 javax.xml.stream.Location defLoc)
Method Detail

create

public static IntEntity create(java.lang.String id,
                               java.lang.String repl)

create

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

getNotationName

public java.lang.String getNotationName()
Specified by:
getNotationName in interface javax.xml.stream.events.EntityDeclaration
Specified by:
getNotationName in class EntityDecl

getPublicId

public java.lang.String getPublicId()
Specified by:
getPublicId in interface javax.xml.stream.events.EntityDeclaration
Specified by:
getPublicId in class EntityDecl

getReplacementText

public java.lang.String getReplacementText()
Specified by:
getReplacementText in interface javax.xml.stream.events.EntityDeclaration
Specified by:
getReplacementText in class EntityDecl

getReplacementText

public int getReplacementText(java.io.Writer w)
                       throws java.io.IOException
Specified by:
getReplacementText in class EntityDecl
Throws:
java.io.IOException

getSystemId

public java.lang.String getSystemId()
Specified by:
getSystemId in interface javax.xml.stream.events.EntityDeclaration
Specified by:
getSystemId in class EntityDecl

writeEnc

public void writeEnc(java.io.Writer w)
              throws java.io.IOException
Specified by:
writeEnc in class EntityDecl
Throws:
java.io.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,
                              javax.xml.stream.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