BitFilePosition (Terrier Information Retrieval Platform 5.5 API)

All Known Subinterfaces:

BitIndexPointer

All Known Implementing Classes:

BasicDocumentIndexEntry, BasicLexiconEntry, DocumentIndexEntry, FieldDocumentIndexEntry, FieldLexiconEntry, FilePosition, MultiDocumentEntry, NonIncrementalDocumentIndexEntry, SimpleBitIndexPointer, SimpleDocumentIndexEntry, Tr3BlockFieldLexiconEntry, Tr3BlockLexiconEntry, Tr4BasicLexiconEntry, Tr4FieldLexiconEntry
```
public interface BitFilePosition
```
A (number of bytes, number of bits) position in a bit file.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getOffset()`	Return the number of bytes offset.
`byte`	`getOffsetBits()`	Return the number of bits offset.
`void`	`setOffset(long bytes, byte bits)`	Set the offset in number of bytes and number of bits.
`void`	`setOffset(BitFilePosition pos)`	Sets the bit file position within this object to that represented by the specified bit file position.

- Method Detail
  - getOffset
```
long getOffset()
```
    Return the number of bytes offset.
    
    Returns:
    
    the number of bytes offset.
  - getOffsetBits
```
byte getOffsetBits()
```
    Return the number of bits offset.
    
    Returns:
    
    the number of bits offset.
  - setOffset
```
void setOffset(long bytes,
               byte bits)
```
    Set the offset in number of bytes and number of bits.
    
    Parameters:
    
    bytes - the number of bytes to set.
    
    bits - the number of bits to set.
  - setOffset
```
void setOffset(BitFilePosition pos)
```
    Sets the bit file position within this object to that represented by the specified bit file position.
    
    Parameters:
    
    pos - other bit file position to update the bit file position in this object.