Modifier and Type	Class and Description
public static class	Entity.ExternalEntity External entity.
public static class	Entity.InternalEntity Internal entity.
public static class	Entity.ScannedEntity Entity state.

Modifier and Type	Field and Description
public boolean	inExternalSubset
public String	name Entity name.

Access	Constructor and Description
public	Entity() Default constructor.
public	Entity(String name, boolean inExternalSubset) Constructs an entity.

Modifier and Type	Method and Description
public void	clear() Clears the entity.
public boolean	isEntityDeclInExternalSubset() Returns true if this entity was declared in the external subset.
public abstract boolean	isExternal() Returns true if this is an external entity.
public abstract boolean	isUnparsed() Returns true if this is an unparsed entity.
public void	setValues(Entity entity) Sets the values of the entity.

inExternalSubset	back to summary
public boolean inExternalSubset

name	back to summary
public String name Entity name.

Entity	back to summary
public Entity() Default constructor.

Entity	back to summary
public Entity(String name, boolean inExternalSubset) Constructs an entity.

clear	back to summary
public void clear() Clears the entity.

isEntityDeclInExternalSubset	back to summary
public boolean isEntityDeclInExternalSubset() Returns true if this entity was declared in the external subset.

isExternal	back to summary
public abstract boolean isExternal() Returns true if this is an external entity.

isUnparsed	back to summary
public abstract boolean isUnparsed() Returns true if this is an unparsed entity.

setValues	back to summary
public void setValues(Entity entity) Sets the values of the entity.

com.sun.xml.internal.stream back to summary

public Class Entity.ExternalEntity

Class Inheritance

extends Entity

java.lang.Object
com.sun.xml.internal.stream.Entity
com.sun.xml.internal.stream.Entity.ExternalEntity

External entity.

Author: nb131165

Field Summary

Modifier and Type	Field and Description
public XMLResourceIdentifier	entityLocation container for all relevant entity location information.
public String	notation Notation name for unparsed entity.

Inherited from com.sun.xml.internal.stream.Entity:: inExternalSubset name

Constructor Summary

Access	Constructor and Description
public	ExternalEntity() Default constructor.
public	ExternalEntity(String name, XMLResourceIdentifier entityLocation, String notation, boolean inExternalSubset) Constructs an internal entity.

Method Summary

Modifier and Type	Method and Description
public void	clear() Overrides com.sun.xml.internal.stream.Entity.clear. Clears the entity.
public final boolean	isExternal() Implements abstract com.sun.xml.internal.stream.Entity.isExternal. Returns true if this is an external entity.
public final boolean	isUnparsed() Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed. Returns true if this is an unparsed entity.
public void	setValues(Entity entity) Overrides com.sun.xml.internal.stream.Entity.setValues. Sets the values of the entity.
public void	setValues(Entity.ExternalEntity entity) Sets the values of the entity.

Inherited from com.sun.xml.internal.stream.Entity:: isEntityDeclInExternalSubset

Field Detail

entityLocation	back to summary
public XMLResourceIdentifier entityLocation container for all relevant entity location information.

notation	back to summary
public String notation Notation name for unparsed entity.

Constructor Detail

ExternalEntity	back to summary
public ExternalEntity() Default constructor.

ExternalEntity	back to summary
public ExternalEntity(String name, XMLResourceIdentifier entityLocation, String notation, boolean inExternalSubset) Constructs an internal entity.

Method Detail

clear	back to summary
public void clear() Overrides com.sun.xml.internal.stream.Entity.clear. Clears the entity.

clear

back to summary

public void clear()

Overrides com.sun.xml.internal.stream.Entity.clear.

Clears the entity.

isExternal	back to summary
public final boolean isExternal() Implements abstract com.sun.xml.internal.stream.Entity.isExternal. Returns true if this is an external entity.

isExternal

back to summary

public final boolean isExternal()

Implements abstract com.sun.xml.internal.stream.Entity.isExternal.

Returns true if this is an external entity.

isUnparsed	back to summary
public final boolean isUnparsed() Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed. Returns true if this is an unparsed entity.

isUnparsed

back to summary

public final boolean isUnparsed()

Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed.

Returns true if this is an unparsed entity.

setValues	back to summary
public void setValues(Entity entity) Overrides com.sun.xml.internal.stream.Entity.setValues. Sets the values of the entity.

setValues

back to summary

public void setValues(Entity entity)

Overrides com.sun.xml.internal.stream.Entity.setValues.

Sets the values of the entity.

setValues	back to summary
public void setValues(Entity.ExternalEntity entity) Sets the values of the entity.

com.sun.xml.internal.stream back to summary

public Class Entity.InternalEntity

Class Inheritance

extends Entity

java.lang.Object
com.sun.xml.internal.stream.Entity
com.sun.xml.internal.stream.Entity.InternalEntity

Internal entity.

Author: nb131165

Field Summary

Modifier and Type	Field and Description
public String	text Text value of entity.

Inherited from com.sun.xml.internal.stream.Entity:: inExternalSubset name

Constructor Summary

Access	Constructor and Description
public	InternalEntity() Default constructor.
public	InternalEntity(String name, String text, boolean inExternalSubset) Constructs an internal entity.

Method Summary

Modifier and Type	Method and Description
public void	clear() Overrides com.sun.xml.internal.stream.Entity.clear. Clears the entity.
public final boolean	isExternal() Implements abstract com.sun.xml.internal.stream.Entity.isExternal. Returns true if this is an external entity.
public final boolean	isUnparsed() Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed. Returns true if this is an unparsed entity.
public void	setValues(Entity entity) Overrides com.sun.xml.internal.stream.Entity.setValues. Sets the values of the entity.
public void	setValues(Entity.InternalEntity entity) Sets the values of the entity.

Inherited from com.sun.xml.internal.stream.Entity:: isEntityDeclInExternalSubset

Field Detail

text	back to summary
public String text Text value of entity.

Constructor Detail

InternalEntity	back to summary
public InternalEntity() Default constructor.

InternalEntity	back to summary
public InternalEntity(String name, String text, boolean inExternalSubset) Constructs an internal entity.

Method Detail

clear	back to summary
public void clear() Overrides com.sun.xml.internal.stream.Entity.clear. Clears the entity.

clear

back to summary

public void clear()

Overrides com.sun.xml.internal.stream.Entity.clear.

Clears the entity.

isExternal	back to summary
public final boolean isExternal() Implements abstract com.sun.xml.internal.stream.Entity.isExternal. Returns true if this is an external entity.

isExternal

back to summary

public final boolean isExternal()

Implements abstract com.sun.xml.internal.stream.Entity.isExternal.

Returns true if this is an external entity.

isUnparsed	back to summary
public final boolean isUnparsed() Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed. Returns true if this is an unparsed entity.

isUnparsed

back to summary

public final boolean isUnparsed()

Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed.

Returns true if this is an unparsed entity.

setValues	back to summary
public void setValues(Entity entity) Overrides com.sun.xml.internal.stream.Entity.setValues. Sets the values of the entity.

setValues

back to summary

public void setValues(Entity entity)

Overrides com.sun.xml.internal.stream.Entity.setValues.

Sets the values of the entity.

setValues	back to summary
public void setValues(Entity.InternalEntity entity) Sets the values of the entity.

com.sun.xml.internal.stream back to summary

public Class Entity.ScannedEntity

Class Inheritance

extends Entity

java.lang.Object
com.sun.xml.internal.stream.Entity
com.sun.xml.internal.stream.Entity.ScannedEntity

Entity state.

Author: nb131165

Field Summary

Modifier and Type	Field and Description
public int	baseCharOffset Base character offset for computing absolute character offset.
public char[]	ch Character buffer.
public int	columnNumber Column number.
public int	count Count of characters present in buffer.
pack-priv boolean	declaredEncoding Encoding has been set externally for eg: using DOMInput
public static final int	DEFAULT_BUFFER_SIZE Default buffer size (4096).
public static final int	DEFAULT_INTERNAL_BUFFER_SIZE Default internal entity buffer size (1024).
public static final int	DEFAULT_XMLDECL_BUFFER_SIZE Default buffer size before we've finished with the XMLDecl:
public String	encoding Auto-detected encoding.
public XMLResourceIdentifier	entityLocation entity location information
pack-priv boolean	externallySpecifiedEncoding Encoding has been set externally, for example using a SAX InputSource or a DOM LSInput.
public int	fBufferSize Buffer size.
public int	fLastCount This variable stores the number of characters read during the load() operation.
public int	fTotalCountTillLastLoad This variable is used to calculate the current position in the XML stream.
public boolean	isExternal
public boolean	isGE
public int	lineNumber Line number.
public boolean	literal True if in a literal.
public boolean	mayReadChunks
public int	position Position in character buffer at any point of time.
public Reader	reader XXX let these field remain public right now, though we have defined methods for them.
public int	startPosition Start position in character buffer.
public InputStream	stream XXX let these field remain public right now, though we have defined methods for them.
public String	version
public boolean	xmlDeclChunkRead
public String	xmlVersion XML version.

Inherited from com.sun.xml.internal.stream.Entity:: inExternalSubset name

Constructor Summary

Access	Constructor and Description
public	ScannedEntity(boolean isGE, String name, XMLResourceIdentifier entityLocation, InputStream stream, Reader reader, String encoding, boolean literal, boolean mayReadChunks, boolean isExternal) Constructs a scanned entity.

Method Summary

Modifier and Type	Method and Description
public void	close() Release any resources associated with this entity.
public String	Returns: current encoding name getEncodingName() returns the name of the current encoding
public InputStream	Returns: java.io.InputStream InputStream associated with this entity getEntityInputStream() if entity was opened using the stream, return the associated inputstream with this entity
public Reader	Returns: java.io.Reader Reader associated with this entity getEntityReader() Returns the java.io.Reader associated with this entity.Readers are used to read from the file.
public String	Returns: String version of the entity, for an internal entity version would be null getEntityVersion() each 'external' parsed entity may have xml/text declaration containing version information
public boolean	isDeclaredEncoding()
public boolean	isEncodingExternallySpecified() Returns whether the encoding of this entity was externally specified.
public final boolean	isExternal() Implements abstract com.sun.xml.internal.stream.Entity.isExternal. Returns true if this is an external entity.
public final boolean	isUnparsed() Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed. Returns true if this is an unparsed entity.
public void	setDeclaredEncoding(boolean value)
public void	setEncodingExternallySpecified(boolean value) Sets whether the encoding of this entity was externally specified.
public void	setEntityVersion(String version) each 'external' parsed entity may have xml/text declaration containing version information
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of this object.

Inherited from com.sun.xml.internal.stream.Entity:: clear isEntityDeclInExternalSubset setValues

Field Detail

baseCharOffset	back to summary
public int baseCharOffset Base character offset for computing absolute character offset.

ch	back to summary
public char[] ch Character buffer.

columnNumber	back to summary
public int columnNumber Column number.

count	back to summary
public int count Count of characters present in buffer.

declaredEncoding	back to summary
pack-priv boolean declaredEncoding Encoding has been set externally for eg: using DOMInput

DEFAULT_BUFFER_SIZE	back to summary
public static final int DEFAULT_BUFFER_SIZE Default buffer size (4096).

DEFAULT_INTERNAL_BUFFER_SIZE	back to summary
public static final int DEFAULT_INTERNAL_BUFFER_SIZE Default internal entity buffer size (1024).

DEFAULT_XMLDECL_BUFFER_SIZE	back to summary
public static final int DEFAULT_XMLDECL_BUFFER_SIZE Default buffer size before we've finished with the XMLDecl:

encoding	back to summary
public String encoding Auto-detected encoding.

entityLocation	back to summary
public XMLResourceIdentifier entityLocation entity location information

externallySpecifiedEncoding	back to summary
pack-priv boolean externallySpecifiedEncoding Encoding has been set externally, for example using a SAX InputSource or a DOM LSInput.

fBufferSize	back to summary
public int fBufferSize Buffer size. We get this value from a property. The default size is used if the input buffer size property is not specified. Revisit do we need a property for internal entity buffer size?

fLastCount	back to summary
public int fLastCount This variable stores the number of characters read during the load() operation. It is used to calculate fTotalCountTillLastLoad

fTotalCountTillLastLoad	back to summary
public int fTotalCountTillLastLoad This variable is used to calculate the current position in the XML stream. Note that fCurrentEntity.position maintains the position relative to the buffer. At any point of time absolute position in the XML stream can be calculated as fTotalCountTillLastLoad + fCurrentEntity.position

isExternal	back to summary
public boolean isExternal

isGE	back to summary
public boolean isGE

lineNumber	back to summary
public int lineNumber Line number.

literal	back to summary
public boolean literal True if in a literal.

mayReadChunks	back to summary
public boolean mayReadChunks

position	back to summary
public int position Position in character buffer at any point of time.

reader	back to summary
public Reader reader XXX let these field remain public right now, though we have defined methods for them. Reader.

startPosition	back to summary
public int startPosition Start position in character buffer.

stream	back to summary
public InputStream stream XXX let these field remain public right now, though we have defined methods for them. Input stream.

version	back to summary
public String version

xmlDeclChunkRead	back to summary
public boolean xmlDeclChunkRead

xmlVersion	back to summary
public String xmlVersion XML version.

Constructor Detail

ScannedEntity	back to summary
public ScannedEntity(boolean isGE, String name, XMLResourceIdentifier entityLocation, InputStream stream, Reader reader, String encoding, boolean literal, boolean mayReadChunks, boolean isExternal) Constructs a scanned entity.

Method Detail

close	back to summary
public void close() throws IOException Release any resources associated with this entity.

getEncodingName

back to summary

public String getEncodingName()

returns the name of the current encoding

Returns:String: current encoding name

getEntityInputStream

back to summary

public InputStream getEntityInputStream()

if entity was opened using the stream, return the associated inputstream with this entity

Returns:InputStream: java.io.InputStream InputStream associated with this entity

getEntityReader

back to summary

public Reader getEntityReader()

Returns the java.io.Reader associated with this entity.Readers are used to read from the file. Readers wrap any particular InputStream that was used to open the entity.

Returns:Reader: java.io.Reader Reader associated with this entity

getEntityVersion

back to summary

public String getEntityVersion()

each 'external' parsed entity may have xml/text declaration containing version information

Returns:String: String version of the entity, for an internal entity version would be null

isDeclaredEncoding	back to summary
public boolean isDeclaredEncoding()

isEncodingExternallySpecified	back to summary
public boolean isEncodingExternallySpecified() Returns whether the encoding of this entity was externally specified.

isExternal

back to summary

public final boolean isExternal()

Implements abstract com.sun.xml.internal.stream.Entity.isExternal.

Returns true if this is an external entity.

isUnparsed

back to summary

public final boolean isUnparsed()

Implements abstract com.sun.xml.internal.stream.Entity.isUnparsed.

Returns true if this is an unparsed entity.

setDeclaredEncoding	back to summary
public void setDeclaredEncoding(boolean value)

setEncodingExternallySpecified	back to summary
public void setEncodingExternallySpecified(boolean value) Sets whether the encoding of this entity was externally specified.

setEntityVersion	back to summary
public void setEntityVersion(String version) each 'external' parsed entity may have xml/text declaration containing version information

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this object.

public abstract Class Entity

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Entity.ExternalEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Entity.InternalEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Entity.ScannedEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail