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

Field Summary

Modifier and Type	Field and Description
protected final Location	mContentLocation Location where entity content definition started; points to the starting/opening quote for internal entities.
pack-priv final char[]	mRepl Replacement text of the entity; full array contents.
pack-priv String	mReplText

Modifier and Type

Field and Description

protected final Location

mContentLocation

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

pack-priv final char[]

mRepl

Replacement text of the entity; full array contents.

pack-priv String

mReplText

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

Access

Constructor and Description

public

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

Modifier and Type	Method and Description
public static IntEntity	create(String id, String repl)
public static IntEntity	create(String id, char[] val)
public 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 String	getNotationName() Implements abstract com.ctc.wstx.ent.EntityDecl.getNotationName. Implements javax.xml.stream.events.EntityDeclaration.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. Gives raw access to replacement text data...
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 boolean	isParsed() Implements abstract com.ctc.wstx.ent.EntityDecl.isParsed.
public void	writeEnc(Writer w) Implements abstract com.ctc.wstx.ent.EntityDecl.writeEnc.

Modifier and Type

Method and Description

public static IntEntity

create(String id, String repl)

public static IntEntity

create(String id, char[] val)

public 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 String

getNotationName()

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

Implements javax.xml.stream.events.EntityDeclaration.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.

Gives raw access to replacement text data...

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 boolean

isParsed()

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

public void

writeEnc(Writer w)

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

Field Detail

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

mContentLocation

back to summary

protected final Location mContentLocation

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

mRepl	back to summary
pack-priv final char[] mRepl Replacement text of the entity; full array contents.

mRepl

back to summary

pack-priv final char[] mRepl

Replacement text of the entity; full array contents.

mReplText	back to summary
pack-priv String mReplText

mReplText

back to summary

pack-priv String mReplText

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

IntEntity

back to summary

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

Method Detail

create	back to summary
public static IntEntity create(String id, String repl)

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

expand	back to summary
public WstxInputSource expand(WstxInputSource parent, XMLResolver res, ReaderConfig cfg, int xmlVersion) 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

expand

back to summary

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

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

getNotationName	back to summary
public String getNotationName() Implements abstract com.ctc.wstx.ent.EntityDecl.getNotationName. Implements javax.xml.stream.events.EntityDeclaration.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 String getNotationName()

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

Implements javax.xml.stream.events.EntityDeclaration.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 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

getPublicId

back 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

getReplacementChars	back to summary
public char[] getReplacementChars() Implements abstract com.ctc.wstx.ent.EntityDecl.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. Annotations @Override

getReplacementChars

back to summary

public char[] getReplacementChars()

Implements abstract com.ctc.wstx.ent.EntityDecl.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.

Annotations

@Override

getReplacementText	back 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

getReplacementText

back 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

getReplacementText	back to summary
public int getReplacementText(Writer w) throws IOException Implements abstract com.ctc.wstx.ent.EntityDecl.getReplacementText. Annotations @Override

getReplacementText

back to summary

public int getReplacementText(Writer w) throws IOException

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

Annotations

@Override

getSystemId	back 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

getSystemId

back 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