uk.ac.gla.terrier.compression
Interface BitInSeekable

All Superinterfaces:

java.io.Closeable

All Known Implementing Classes:

BitFile, BitFileInMemory, OldBitFile

public interface BitInSeekable
extends java.io.Closeable

Interface for BitFile and OldBitFile - future proofing for returning new objects for readReset instead of just the object itself.

Since:

2.0

Version:

$Revision: 1.3 $

Author:

Craig Macdonald

Method Summary

BitIn

readReset(long startByteOffset, byte startBitOffset, long endByteOffset, byte endBitOffset) Reads from the file a specific number of bytes and after this call, a sequence of read calls may follow.

Methods inherited from interface java.io.Closeable

close

Method Detail

readReset

BitIn readReset(long startByteOffset,
                byte startBitOffset,
                long endByteOffset,
                byte endBitOffset)
                throws java.io.IOException

Reads from the file a specific number of bytes and after this call, a sequence of read calls may follow. The offsets given as arguments are inclusive. For example, if we call this method with arguments 0, 2, 1, 7, it will read in a buffer the contents of the underlying file from the third bit of the first byte to the last bit of the second byte.

Parameters:

startByteOffset - the starting byte to read from

startBitOffset - the bit offset in the starting byte

endByteOffset - the ending byte

endBitOffset - the bit offset in the ending byte. This bit is the last bit of this entry.

Returns:

Returns the BitIn object to use to read that data

Throws:

java.io.IOException