|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.io.InputStream com.levigo.jadice.document.io.SeekableInputStream com.levigo.jadice.document.io.RandomAccessFileInputStream
public class RandomAccessFileInputStream
An Implementation of the SeekableInputStream
which is based on a
locally accessible file.
Field Summary |
---|
Fields inherited from class com.levigo.jadice.document.io.SeekableInputStream |
---|
bitOffset, byteOrder, flushedPos |
Constructor Summary | |
---|---|
RandomAccessFileInputStream(File file)
Creates a seekable file access stream |
Method Summary | |
---|---|
void |
close()
Closes this seekable input stream. |
protected void |
finalize()
Finalizes this object prior to garbage collection. |
int |
getReadAhead()
|
long |
getSizeEstimate()
A rough estimated size for this stream instance, which is used for internal cache management. |
long |
getStreamPosition()
|
long |
length()
Returns the length of this stream contents. |
int |
read()
Reads a single byte from the stream and returns it as an int between 0 and 255. |
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes from the stream, and stores them into b
starting at index off . |
void |
seek(long pos)
Sets the current stream position, measured from the beginning of this data stream, at which the next read occurs. |
void |
setReadAhead(int readAhead)
|
Methods inherited from class com.levigo.jadice.document.io.SeekableInputStream |
---|
checkClosed, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, isCached, isCachedFile, isCachedMemory, mark, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedShort, readUTF, reset, resetToInitialState, setBitOffset, setByteOrder, skip, skipBytes, skipBytes |
Methods inherited from class java.io.InputStream |
---|
available, markSupported |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RandomAccessFileInputStream(File file) throws IOException
file
-
IOException
Method Detail |
---|
public long getStreamPosition() throws IOException
IOException
ImageInputStream.getStreamPosition()
public long length() throws IOException
The length will be determined by a call on the underlying RandomAccessFile
. It is to be
noted that a call of RandomAccessFile.length()
is not thread safe. If this method should
be used in multithreaded situations, the developer has to perform an appropriate
synchronisation in order to achieve the desired result.
length
in interface ImageInputStream
length
in class SeekableInputStream
IOException
- if an I/O error occurs or the streams has been already closed.SeekableInputStream.length()
public void seek(long pos) throws IOException
SeekableInputStream
EOFException
will be thrown
only if a read is performed. The bit offset is set to 0.
An IndexOutOfBoundsException
will be thrown if pos
is smaller than
the flushed position (as returned by getflushedPosition
).
It is legal to seek past the end of the file; an EOFException
will be thrown only
if a read is performed.
seek
in interface ImageInputStream
seek
in class SeekableInputStream
pos
- a long
containing the desired file pointer position.
IOException
- if any other I/O error occurs.SeekableInputStream.seek(long)
public int read() throws IOException
SeekableInputStream
int
between 0 and 255. If
EOF is reached, -1
is returned.
Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
The bit offset within the stream must be reset to zero before the read occurs.
read
in interface ImageInputStream
read
in class SeekableInputStream
-1
if EOF is reached.
IOException
- if the stream has been closed.InputStream.read()
public int read(byte[] b, int off, int len) throws IOException
SeekableInputStream
len
bytes from the stream, and stores them into b
starting at index off
. If no bytes can be read because the end of the stream has
been reached, -1
is returned.
The bit offset within the stream must be reset to zero before the read occurs.
Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
read
in interface ImageInputStream
read
in class SeekableInputStream
b
- an array of bytes to be written to.off
- the starting position within b
to write to.len
- the maximum number of bytes to read.
-1
to indicate EOF.
IOException
- if an I/O error occurs.InputStream.read(byte[], int, int)
public void close() throws IOException
SeekableInputStream
IOException
s. Additional attempts to SeekableInputStream.close()
, however, have no effect.
close
in interface Closeable
close
in interface ImageInputStream
close
in class SeekableInputStream
IOException
InputStream.close()
protected void finalize() throws Throwable
SeekableInputStream
close
method is called to
close any open input source. This method should not be called from application code.
finalize
in class SeekableInputStream
Throwable
- if an error occurs during superclass finalization.Object.finalize()
public long getSizeEstimate()
SeekableInputStream
getSizeEstimate
in class SeekableInputStream
public int getReadAhead()
public void setReadAhead(int readAhead)
readAhead
- the readAhead to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |