Entity.ScannedEntity (openjdk7-jaxp-external 7.60.33 API)

java.lang.Object
- jdk7u.jaxp.xml.external.stream.Entity
- - jdk7u.jaxp.xml.external.stream.Entity.ScannedEntity

Enclosing class:: Entity

public static class Entity.ScannedEntity
extends Entity

Entity state.

Author:: nb131165

Nested Class Summary
- Nested classes/interfaces inherited from class jdk7u.jaxp.xml.external.stream.Entity
  Entity.ExternalEntity, Entity.InternalEntity, Entity.ScannedEntity

Field Summary

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

Fields inherited from class jdk7u.jaxp.xml.external.stream.Entity
inExternalSubset, name

Constructor Summary

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

Method Summary

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

Methods inherited from class jdk7u.jaxp.xml.external.stream.Entity
clear, isEntityDeclInExternalSubset, setValues

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    Default buffer size (4096).
    
    See Also:
    Constant Field Values
  - fBufferSize
```
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?
  - DEFAULT_XMLDECL_BUFFER_SIZE
```
public static final int DEFAULT_XMLDECL_BUFFER_SIZE
```
    Default buffer size before we've finished with the XMLDecl:
    
    See Also:
    Constant Field Values
  - DEFAULT_INTERNAL_BUFFER_SIZE
```
public static final int DEFAULT_INTERNAL_BUFFER_SIZE
```
    Default internal entity buffer size (1024).
    
    See Also:
    Constant Field Values
  - stream
```
public InputStream stream
```
    XXX let these field remain public right now, though we have defined methods for them. Input stream.
  - reader
```
public Reader reader
```
    XXX let these field remain public right now, though we have defined methods for them. Reader.
  - entityLocation
```
public XMLResourceIdentifier entityLocation
```
    entity location information
  - encoding
```
public String encoding
```
    Auto-detected encoding.
  - literal
```
public boolean literal
```
    True if in a literal.
  - isExternal
```
public boolean isExternal
```
  - version
```
public String version
```
  - ch
```
public char[] ch
```
    Character buffer.
  - position
```
public int position
```
    Position in character buffer at any point of time.
  - count
```
public int count
```
    Count of characters present in buffer.
  - lineNumber
```
public int lineNumber
```
    Line number.
  - columnNumber
```
public int columnNumber
```
    Column number.
  - xmlVersion
```
public String xmlVersion
```
    XML version.
  - fTotalCountTillLastLoad
```
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
  - fLastCount
```
public int fLastCount
```
    This variable stores the number of characters read during the load() operation. It is used to calculate fTotalCountTillLastLoad
  - baseCharOffset
```
public int baseCharOffset
```
    Base character offset for computing absolute character offset.
  - startPosition
```
public int startPosition
```
    Start position in character buffer.
  - mayReadChunks
```
public boolean mayReadChunks
```
  - xmlDeclChunkRead
```
public boolean xmlDeclChunkRead
```
- Constructor Detail
  - Entity.ScannedEntity
```
public Entity.ScannedEntity(String name,
                    XMLResourceIdentifier entityLocation,
                    InputStream stream,
                    Reader reader,
                    String encoding,
                    boolean literal,
                    boolean mayReadChunks,
                    boolean isExternal)
```
    Constructs a scanned entity.
- Method Detail
  - getEncodingName
```
public String getEncodingName()
```
    returns the name of the current encoding
    
    Returns:
    current encoding name
  - getEntityVersion
```
public String getEntityVersion()
```
    each 'external' parsed entity may have xml/text declaration containing version information
    
    Returns:
    String version of the enity, for an internal entity version would be null
  - setEntityVersion
```
public void setEntityVersion(String version)
```
    each 'external' parsed entity may have xml/text declaration containing version information
    
    Parameters:
    String - version of the external parsed entity
  - getEntityReader
```
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:
    java.io.Reader Reader associated with this entity
  - getEntityInputStream
```
public InputStream getEntityInputStream()
```
    if entity was opened using the stream, return the associated inputstream with this entity
    
    Returns:
    java.io.InputStream InputStream associated with this entity
  - close
```
public void close()
           throws IOException
```
    Release any resources associated with this entity.
    
    Throws:
    
    IOException
  - isEncodingExternallySpecified
```
public boolean isEncodingExternallySpecified()
```
    Returns whether the encoding of this entity was externally specified.
  - setEncodingExternallySpecified
```
public void setEncodingExternallySpecified(boolean value)
```
    Sets whether the encoding of this entity was externally specified.
  - isDeclaredEncoding
```
public boolean isDeclaredEncoding()
```
  - setDeclaredEncoding
```
public void setDeclaredEncoding(boolean value)
```
  - isExternal
```
public final boolean isExternal()
```
    Returns true if this is an external entity.
    
    Specified by:
    
    isExternal in class Entity
  - isUnparsed
```
public final boolean isUnparsed()
```
    Returns true if this is an unparsed entity.
    
    Specified by:
    
    isUnparsed in class Entity
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object

Class Entity.ScannedEntity

Nested Class Summary

Nested classes/interfaces inherited from class jdk7u.jaxp.xml.external.stream.Entity

Field Summary

Fields inherited from class jdk7u.jaxp.xml.external.stream.Entity

Constructor Summary

Method Summary

Methods inherited from class jdk7u.jaxp.xml.external.stream.Entity

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

fBufferSize

DEFAULT_XMLDECL_BUFFER_SIZE

DEFAULT_INTERNAL_BUFFER_SIZE

stream

reader

entityLocation

encoding

literal

isExternal

version

ch

position

count

lineNumber

columnNumber

xmlVersion

fTotalCountTillLastLoad

fLastCount

baseCharOffset

startPosition

mayReadChunks

xmlDeclChunkRead

Constructor Detail

Entity.ScannedEntity

Method Detail

getEncodingName

getEntityVersion

setEntityVersion

getEntityReader

getEntityInputStream

close

isEncodingExternallySpecified

setEncodingExternallySpecified

isDeclaredEncoding

setDeclaredEncoding

isExternal

isUnparsed

toString