|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.terrier.structures.FilePosition
public class FilePosition
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.
Field Summary | |
---|---|
byte |
Bits
The offset in bits within the pointed byte. |
long |
Bytes
The offset within a file in bytes. |
protected static int |
sizeInBytes
The number of bytes a file position could be converted to - 8 for the byte's long, 1 for the bits |
Constructor Summary | |
---|---|
FilePosition()
Default constructor. |
|
FilePosition(BitFilePosition in)
Create a new FilePosition based on an existing one |
|
FilePosition(byte[] in)
Create an instance based on a byte buffer |
|
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? |
long |
getOffset()
Return the offset |
byte |
getOffsetBits()
Return the offset bits |
int |
hashCode()
Define a hashcode for this - objects which defined equals(Object) should define hashCode() also |
void |
setOffset(BitFilePosition pos)
Set the offset |
void |
setOffset(long bytes,
byte bits)
Set the offset in bytes and bits |
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 |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final int sizeInBytes
public long Bytes
public byte Bits
Constructor Detail |
---|
public FilePosition()
public FilePosition(long bytesPosition, byte bitsPosition)
bytesPosition
- long the given byte offset.bitsPosition
- byte the given bit offset.public FilePosition(byte[] in)
public FilePosition(BitFilePosition in)
Method Detail |
---|
public long getOffset()
getOffset
in interface BitFilePosition
public byte getOffsetBits()
getOffsetBits
in interface BitFilePosition
public void setOffset(long bytes, byte bits)
setOffset
in interface BitFilePosition
public void setOffset(BitFilePosition pos)
setOffset
in interface BitFilePosition
public static int sizeInBytes()
public void toBytes(java.io.DataOutput dai)
public void build(java.io.DataInput di)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |