Top Fields Constructors Methods
com.ctc.wstx.ent

public abstract Class ExtEntity

extends EntityDecl
Class Inheritance
Known Direct Subclasses
com.ctc.wstx.ent.ParsedExtEntity, com.ctc.wstx.ent.UnparsedExtEntity
Imports
com.ctc.wstx.api.ReaderConfig, java.io.IOException, .Writer, java.net.URL, javax.xml.stream.Location, .XMLResolver, .XMLStreamException, com.ctc.wstx.io.WstxInputSource

Field Summary

Modifier and TypeField and Description
pack-priv final String
mPublicId

pack-priv final String
mSystemId

Inherited from com.ctc.wstx.ent.EntityDecl:
mContextmDeclaredExternallymName

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public abstract WstxInputSource
expand(WstxInputSource parent, XMLResolver res, ReaderConfig cfg, int xmlVersion)

Implements abstract com.ctc.wstx.ent.EntityDecl.expand.

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

public abstract String
getNotationName()

Redeclares javax.xml.stream.events.EntityDeclaration.getNotationName.

Implements abstract com.ctc.wstx.ent.EntityDecl.getNotationName.

The name of the associated notation.

public String
getPublicId()

Implements abstract com.ctc.wstx.ent.EntityDecl.getPublicId.

Implements javax.xml.stream.events.EntityDeclaration.getPublicId.

The entity's public identifier, or null if none was given

public char[]
getReplacementChars()

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementChars.

public String
getReplacementText()

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementText.

Implements javax.xml.stream.events.EntityDeclaration.getReplacementText.

The replacement text of the entity.

public int
getReplacementText(Writer w)

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementText.

public String
getSystemId()

Implements abstract com.ctc.wstx.ent.EntityDecl.getSystemId.

Implements javax.xml.stream.events.EntityDeclaration.getSystemId.

The entity's system identifier.

public boolean
isExternal()

Implements abstract com.ctc.wstx.ent.EntityDecl.isExternal.

public abstract boolean
isParsed()

Implements abstract com.ctc.wstx.ent.EntityDecl.isParsed.

public abstract void
writeEnc(Writer w)

Implements abstract com.ctc.wstx.ent.EntityDecl.writeEnc.

Inherited from com.ctc.wstx.ent.EntityDecl:
getBaseURIgetNamegetReplacementTextLengthmarkAsExternallyDeclaredwasDeclaredExternally

Field Detail

mPublicIdback to summary
pack-priv final String mPublicId
mSystemIdback to summary
pack-priv final String mSystemId

Constructor Detail

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

Method Detail

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

Implements abstract com.ctc.wstx.ent.EntityDecl.expand.

Doc from com.ctc.wstx.ent.EntityDecl.expand.

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

Annotations
@Override
getNotationNameback to summary
public abstract String getNotationName()

Redeclares javax.xml.stream.events.EntityDeclaration.getNotationName.

Implements abstract com.ctc.wstx.ent.EntityDecl.getNotationName.

Doc from javax.xml.stream.events.EntityDeclaration.getNotationName.

The name of the associated notation.

Returns:String

the notation name

Annotations
@Override
getPublicIdback to summary
public String getPublicId()

Implements abstract com.ctc.wstx.ent.EntityDecl.getPublicId.

Implements javax.xml.stream.events.EntityDeclaration.getPublicId.

Doc from javax.xml.stream.events.EntityDeclaration.getPublicId.

The entity's public identifier, or null if none was given

Returns:String

the public ID for this declaration or null

Annotations
@Override
getReplacementCharsback to summary
public char[] getReplacementChars()

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementChars.

Annotations
@Override
getReplacementTextback to summary
public String getReplacementText()

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementText.

Implements javax.xml.stream.events.EntityDeclaration.getReplacementText.

Doc from javax.xml.stream.events.EntityDeclaration.getReplacementText.

The replacement text of the entity. This method will only return non-null if this is an internal entity.

Returns:String

null or the replacement text

Annotations
@Override
getReplacementTextback to summary
public int getReplacementText(Writer w)

Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementText.

Annotations
@Override
getSystemIdback to summary
public String getSystemId()

Implements abstract com.ctc.wstx.ent.EntityDecl.getSystemId.

Implements javax.xml.stream.events.EntityDeclaration.getSystemId.

Doc from javax.xml.stream.events.EntityDeclaration.getSystemId.

The entity's system identifier.

Returns:String

the system ID for this declaration or null

Annotations
@Override
isExternalback to summary
public boolean isExternal()

Implements abstract com.ctc.wstx.ent.EntityDecl.isExternal.

Annotations
@Override
isParsedback to summary
public abstract boolean isParsed()

Implements abstract com.ctc.wstx.ent.EntityDecl.isParsed.

Annotations
@Override
writeEncback to summary
public abstract void writeEnc(Writer w) throws IOException

Implements abstract com.ctc.wstx.ent.EntityDecl.writeEnc.

Annotations
@Override