com.terracottatech.offheapstore.filesystem

Class SeekableInputStream

java.lang.Object

java.io.InputStream

com.terracottatech.offheapstore.filesystem.SeekableInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

OffheapInputStream

public abstract class SeekableInputStream
extends InputStream

This interface provides for reading bytes from an OffHeap File.

It is generally true of all the reading routines in this interface that if end of file is reached before the desired number of bytes has been read, an EOFException (which is a kind of IOException) is thrown. If any byte cannot be read for any reason other than end of file, an IOException other than EOFException is thrown. In particular, an IOException may be thrown if the input stream has been closed.

Author:

dkumar

Constructor Summary

Constructors

Constructor and Description
SeekableInputStream()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this stream and releases any system resources associated with the stream.
abstract long	getFilePointer() Returns the current offset in this file.
abstract int	read()
abstract void	readBytes(byte[] b, int offset, int len)
abstract void	seek(long pos) Sets the file-pointer offset, measured from the beginning of this file, at which the next read occurs.

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeekableInputStream

public SeekableInputStream()

Method Detail

read

public abstract int read()
                  throws IOException

Specified by:

read in class InputStream

Throws:

IOException

readBytes

public abstract void readBytes(byte[] b,
                               int offset,
                               int len)
                        throws IOException

Throws:

IOException

getFilePointer

public abstract long getFilePointer()
                             throws IOException

Returns the current offset in this file.

Returns:

the offset from the beginning of the file, in bytes, at which the next read occurs.

Throws:

IOException - if an I/O error occurs.

close

public abstract void close()
                    throws IOException

Closes this stream and releases any system resources associated with the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.

seek

public abstract void seek(long pos)
                   throws IOException,
                          EOFException

Sets the file-pointer offset, measured from the beginning of this file, at which the next read occurs.

Parameters:

pos - - the offset position, measured in bytes from the beginning of the file, at which to set the file pointer.

Throws:

IOException - if pos is less than 0 or if an I/O error occurs.

EOFException - if pos beyond end of file