Package bref

Class BrefBlock

java.lang.Object

bref.BrefBlock

public class BrefBlock
extends java.lang.Object

Class BrefBlock represents starting chromosome coordinates and file offset for the start of a binary reference format (bref) data block.

Instances of class BrefBlock are immutable.

Constructor Summary

Constructors

Constructor	Description
BrefBlock(int chromIndex, int pos, long offset)	Constructs a BrefBlock for the specified data.

Method Summary

Modifier and Type	Method	Description
int	chromIndex()	Returns the chromosome index of the first marker in this bref block.
long	offset()	Returns the file offset of the first marker in this bref block.
int	pos()	Returns the chromosome position of the first marker in this bref block.
java.lang.String	toString()	Returns a string description of this.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrefBlock

public BrefBlock(int chromIndex,
                 int pos,
                 long offset)

Constructs a BrefBlock for the specified data. It is the caller's responsibility to ensure the consistency of the constructor parameters.

Parameters:

chromIndex - the chromosome index

pos - the starting chromosome position

offset - the file offset in bytes for the bref data block

Method Detail

chromIndex

public int chromIndex()

Returns the chromosome index of the first marker in this bref block.

Returns:

the chromosome index of the first marker in this bref block

pos

public int pos()

Returns the chromosome position of the first marker in this bref block.

Returns:

the chromosome position of the first marker in this bref block

offset

public long offset()

Returns the file offset of the first marker in this bref block.

Returns:

the file offset of the first marker in this bref block

toString

public java.lang.String toString()

Returns a string description of this. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a string description of this