uk.ac.gla.terrier.structures
Class FilePosition

java.lang.Object
  uk.ac.gla.terrier.structures.FilePosition

public class FilePosition
extends java.lang.Object

Models a position within a file as the offset in bytes and the offset in bits in that byte. For example, an instance of the class FilePosition that points to the 10th bit of a file should be constructed with a byte offset of 1 and a bit offset of 2.

Author:

Craig Macdonald, Vassilis Plachouras & John Kane

Field Summary

byte	Bits The offset in bits within the pointed byte.
long	Bytes The offset within a file in bytes.

Constructor Summary

FilePosition()
Default constructor.

FilePosition(byte[] in)
Create an instance based on a byte buffer

FilePosition(FilePosition in)
Create a new FilePosition based on an existing one

FilePosition(long bytesPosition, byte bitsPosition)
Creates an instance of the class from the given byte and bit offsets.

Method Summary

void	build(java.io.DataInput di) unseralize this object from the named dataoutput instance
boolean	equals(java.lang.Object o) Is this FilePosition equal to another?
int	hashCode() Define a hashcode for this - objects which defined equals(Object) should define hashCode() also
static int	sizeInBytes() How large is this object when serialized
void	toBytes(java.io.DataOutput dai) Seralize this object to the named dataoutput instance
java.lang.String	toString() String representation of this object

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

Bytes

public long Bytes

The offset within a file in bytes.

Bits

public byte Bits

The offset in bits within the pointed byte.

Constructor Detail

FilePosition

public FilePosition()

Default constructor. Create an uninitialiased FilePosition

FilePosition

public FilePosition(long bytesPosition,
                    byte bitsPosition)

Creates an instance of the class from the given byte and bit offsets.

Parameters:

bytesPosition - long the given byte offset.

bitsPosition - byte the given bit offset.

FilePosition

public FilePosition(byte[] in)

Create an instance based on a byte buffer

FilePosition

public FilePosition(FilePosition in)

Create a new FilePosition based on an existing one

Method Detail

sizeInBytes

public static int sizeInBytes()

How large is this object when serialized

toBytes

public void toBytes(java.io.DataOutput dai)

Seralize this object to the named dataoutput instance

build

public void build(java.io.DataInput di)

unseralize this object from the named dataoutput instance

equals

public boolean equals(java.lang.Object o)

Is this FilePosition equal to another?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Define a hashcode for this - objects which defined equals(Object) should define hashCode() also

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

String representation of this object

Overrides:

toString in class java.lang.Object