Woodstox 6.5.1 · com.ctc.wstx.ent.EntityDecl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv final URL	mContext Context that is to be used to resolve references encountered from expanded contents of this entity.
protected boolean	mDeclaredExternally Flag that can be set to indicate that the declaration was in the external DTD subset.
pack-priv final String	mName Name/id of the entity used to reference it.

Access	Constructor and Description
public	EntityDecl(Location loc, String name, URL ctxt)

Method Summary

Modifier and Type	Method and Description
public 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.
public final String	getBaseURI() Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getBaseURI. Implements javax.xml.stream.events.EntityDeclaration.getBaseURI. Get the base URI for this reference or null if this information is not available
public final String	getName() Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getName. Implements javax.xml.stream.events.EntityDeclaration.getName. The entity's name
public abstract String	getNotationName() Redeclares javax.xml.stream.events.EntityDeclaration.getNotationName. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getNotationName. The name of the associated notation.
public abstract String	getPublicId() Redeclares javax.xml.stream.events.EntityDeclaration.getPublicId. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getPublicId. The entity's public identifier, or null if none was given
public abstract char[]	getReplacementChars()
public abstract String	getReplacementText() Redeclares javax.xml.stream.events.EntityDeclaration.getReplacementText. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getReplacementText. The replacement text of the entity.
public abstract int	getReplacementText(Writer w)
public final int	getReplacementTextLength()
public abstract String	getSystemId() Redeclares javax.xml.stream.events.EntityDeclaration.getSystemId. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getSystemId. The entity's system identifier.
public abstract boolean	isExternal()
public abstract boolean	isParsed()
public void	markAsExternallyDeclared()
public boolean	Returns: True, if the declaration occured in the external DTD subset; false if not (internal subset, custom declaration) wasDeclaredExternally()
public abstract void	writeEnc(Writer w) Implements abstract com.ctc.wstx.evt.WEntityDeclaration.writeEnc.

Inherited from com.ctc.wstx.evt.WEntityDeclaration:: equals getEventType hashCode writeAsEncodedUnicode writeUsing

mContext	back to summary
pack-priv final URL mContext Context that is to be used to resolve references encountered from expanded contents of this entity.

mDeclaredExternally	back to summary
protected boolean mDeclaredExternally Flag that can be set to indicate that the declaration was in the external DTD subset. Default is false.

mName	back to summary
pack-priv final String mName Name/id of the entity used to reference it.

EntityDecl	back to summary
public EntityDecl(Location loc, String name, URL ctxt)

Method Detail

expand	back to summary
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.

getBaseURI	back to summary
public final String getBaseURI() Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getBaseURI. Implements javax.xml.stream.events.EntityDeclaration.getBaseURI. Doc from javax.xml.stream.events.EntityDeclaration.getBaseURI. Get the base URI for this reference or null if this information is not available Returns:String the base URI or null Annotations @Override

getBaseURI

back to summary

public final String getBaseURI()

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getBaseURI.

Implements javax.xml.stream.events.EntityDeclaration.getBaseURI.

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

Get the base URI for this reference or null if this information is not available

Returns:String

the base URI or null

Annotations

@Override

getName	back to summary
public final String getName() Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getName. Implements javax.xml.stream.events.EntityDeclaration.getName. Doc from javax.xml.stream.events.EntityDeclaration.getName. The entity's name Returns:String the name, may not be null Annotations @Override

getName

back to summary

public final String getName()

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getName.

Implements javax.xml.stream.events.EntityDeclaration.getName.

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

The entity's name

Returns:String

the name, may not be null

Annotations

@Override

getNotationName	back to summary
public abstract String getNotationName() Redeclares javax.xml.stream.events.EntityDeclaration.getNotationName. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getNotationName. Doc from javax.xml.stream.events.EntityDeclaration.getNotationName. The name of the associated notation. Returns:String the notation name Annotations @Override

getNotationName

back to summary

public abstract String getNotationName()

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

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.getNotationName.

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

The name of the associated notation.

Returns:String

the notation name

Annotations

@Override

getPublicId	back to summary
public abstract String getPublicId() Redeclares javax.xml.stream.events.EntityDeclaration.getPublicId. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

getPublicId

back to summary

public abstract String getPublicId()

Redeclares javax.xml.stream.events.EntityDeclaration.getPublicId.

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

getReplacementChars	back to summary
public abstract char[] getReplacementChars()

getReplacementText	back to summary
public abstract String getReplacementText() Redeclares javax.xml.stream.events.EntityDeclaration.getReplacementText. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

getReplacementText

back to summary

public abstract String getReplacementText()

Redeclares javax.xml.stream.events.EntityDeclaration.getReplacementText.

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

getReplacementText	back to summary
public abstract int getReplacementText(Writer w) throws IOException

getReplacementTextLength	back to summary
public final int getReplacementTextLength()

getSystemId	back to summary
public abstract String getSystemId() Redeclares javax.xml.stream.events.EntityDeclaration.getSystemId. Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

getSystemId

back to summary

public abstract String getSystemId()

Redeclares javax.xml.stream.events.EntityDeclaration.getSystemId.

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.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

isExternal	back to summary
public abstract boolean isExternal()

isParsed	back to summary
public abstract boolean isParsed()

markAsExternallyDeclared	back to summary
public void markAsExternallyDeclared()

wasDeclaredExternally	back to summary
public boolean wasDeclaredExternally() Returns:boolean True, if the declaration occured in the external DTD subset; false if not (internal subset, custom declaration)

writeEnc	back to summary
public abstract void writeEnc(Writer w) throws IOException Implements abstract com.ctc.wstx.evt.WEntityDeclaration.writeEnc. Annotations @Override

writeEnc

back to summary

public abstract void writeEnc(Writer w) throws IOException

Implements abstract com.ctc.wstx.evt.WEntityDeclaration.writeEnc.

Annotations

@Override

public abstract Class EntityDecl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail