Package org.terrier.compression.bit

Class BitFileBuffered.BitInBuffered

java.lang.Object

org.terrier.compression.bit.BitInBase

org.terrier.compression.bit.BitFileBuffered.BitInBuffered

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BitIn

Direct Known Subclasses:

BitFileChannel.FileChannelBitInBuffered, ConcurrentBitFileBuffered.ConcurrentBitInBuffered

Enclosing class:

BitFileBuffered

protected static class BitFileBuffered.BitInBuffered
extends BitInBase

Implements a BitIn around a RandomDataInput

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	inBuffer	buffer for the slice of the file being read
protected RandomDataInput	parentFile	parent file
protected int	readByteOffset	byte offset within the buffer
protected int	size	size of the buffer

Fields inherited from class org.terrier.compression.bit.BitInBase

bitOffset, byteRead, offset

Fields inherited from interface org.terrier.compression.bit.BitIn

USUAL_EXTENSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BitInBuffered()	empty constructor for child classes
	BitInBuffered(RandomDataInput file, long startByteOffset, byte _bitOffset, int _bufLength)	Construct a new BitInBuffered on the specified file, starting at the given offset and with the specified buffer length.

Method Summary

Modifier and Type	Method	Description
void	close()	Does nothing
protected void	incrByte()	Move forward one byte
protected void	incrByte(int i)	Move forward i bytes
void	skipBytes(long len)	Skip a number of bytes while reading the bit file.

Methods inherited from class org.terrier.compression.bit.BitInBase

align, getBitOffset, getByteOffset, readBinary, readDelta, readGamma, readGolomb, readIn, readInterpolativeCoding, readMinimalBinary, readMinimalBinaryZero, readSkewedGolomb, readUnary, skipBits

Methods inherited from class java.lang.Object

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

Field Detail

parentFile

protected RandomDataInput parentFile

parent file

inBuffer

protected byte[] inBuffer

buffer for the slice of the file being read

size

protected int size

size of the buffer

readByteOffset

protected int readByteOffset

byte offset within the buffer

Constructor Detail

BitInBuffered

protected BitInBuffered()

empty constructor for child classes

BitInBuffered

public BitInBuffered(RandomDataInput file,
                     long startByteOffset,
                     byte _bitOffset,
                     int _bufLength)

Construct a new BitInBuffered on the specified file, starting at the given offset and with the specified buffer length.

Parameters:

file - File to seek on

startByteOffset - Start byte offset

_bitOffset - Start bit offset

_bufLength - Number of bytes to buffer

Method Detail

incrByte

protected void incrByte()

Move forward one byte

Specified by:

incrByte in class BitInBase

incrByte

protected void incrByte(int i)

Move forward i bytes

Specified by:

incrByte in class BitInBase

skipBytes

public void skipBytes(long len)
               throws java.io.IOException

Skip a number of bytes while reading the bit file. After this opteration, getBitOffset() == 0, so use skipBits(int) to get getBitOffset() to desired value.

Parameters:

len - The number of bytes to skip

Throws:

java.io.IOException - if an I/O error occurs

close

public void close()

Does nothing