ByteBufferKeyValue (Apache HBase - Common 2.0.0-alpha4 API)

java.lang.Object
- org.apache.hadoop.hbase.ByteBufferCell
- - org.apache.hadoop.hbase.ByteBufferKeyValue

All Implemented Interfaces:

Cloneable, Cell, ExtendedCell, HeapSize, SettableSequenceId, SettableTimestamp

Direct Known Subclasses:

NoTagsByteBufferKeyValue
```
@InterfaceAudience.Private
public class ByteBufferKeyValue
extends ByteBufferCell
implements ExtendedCell
```
This Cell is an implementation of ByteBufferCell where the data resides in off heap/ on heap ByteBuffer

Field Summary

Fields
Modifier and Type Field and Description

protected ByteBuffer buf

static int FIXED_OVERHEAD

protected int length

protected int offset
- Fields inherited from interface org.apache.hadoop.hbase.ExtendedCell
  CELL_NOT_BASED_ON_CHUNK

Fields
Modifier and Type	Field and Description
`protected ByteBuffer`	`buf`
`static int`	`FIXED_OVERHEAD`
`protected int`	`length`
`protected int`	`offset`

Constructor Summary

Constructors
Constructor and Description
`ByteBufferKeyValue(ByteBuffer buf, int offset, int length)`
`ByteBufferKeyValue(ByteBuffer buf, int offset, int length, long seqId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExtendedCell`	`deepClone()` Does a deep copy of the contents to a new memory area and returns it as a new cell.
`boolean`	`equals(Object other)` Needed doing 'contains' on List.
`ByteBuffer`	`getBuffer()`
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`ByteBuffer`	`getFamilyByteBuffer()`
`byte`	`getFamilyLength()`
`int`	`getFamilyOffset()`
`int`	`getFamilyPosition()`
`int`	`getOffset()`
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`ByteBuffer`	`getQualifierByteBuffer()`
`int`	`getQualifierLength()`
`int`	`getQualifierOffset()`
`int`	`getQualifierPosition()`
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`ByteBuffer`	`getRowByteBuffer()`
`short`	`getRowLength()`
`int`	`getRowOffset()`
`int`	`getRowPosition()`
`long`	`getSequenceId()` A region-specific unique monotonically increasing sequence ID given to each Cell.
`int`	`getSerializedSize(boolean withTags)`
`byte[]`	`getTagsArray()` Contiguous raw bytes representing tags that may start at any index in the containing array.
`ByteBuffer`	`getTagsByteBuffer()`
`int`	`getTagsLength()` HBase internally uses 2 bytes to store tags length in Cell.
`int`	`getTagsOffset()`
`int`	`getTagsPosition()`
`long`	`getTimestamp()`
`byte`	`getTypeByte()`
`byte[]`	`getValueArray()` Contiguous raw bytes that may start at any index in the containing array.
`ByteBuffer`	`getValueByteBuffer()`
`int`	`getValueLength()`
`int`	`getValueOffset()`
`int`	`getValuePosition()`
`int`	`hashCode()` In line with `equals(Object)`, only uses the key portion, not the value.
`long`	`heapSize()`
`void`	`setSequenceId(long seqId)` Sets with the given seqId.
`void`	`setTimestamp(byte[] ts, int tsOffset)` Sets with the given timestamp.
`void`	`setTimestamp(long ts)` Sets with the given timestamp.
`String`	`toString()`
`void`	`write(ByteBuffer buf, int offset)` Write this Cell into the given buf's offset in a `KeyValue` format.
`int`	`write(OutputStream out, boolean withTags)` Write this cell to an OutputStream in a `KeyValue` format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.ExtendedCell
getChunkId

- Field Detail
  - buf
```
protected final ByteBuffer buf
```
  - offset
```
protected final int offset
```
  - length
```
protected final int length
```
  - FIXED_OVERHEAD
```
public static final int FIXED_OVERHEAD
```
- Constructor Detail
  - ByteBufferKeyValue
```
public ByteBufferKeyValue(ByteBuffer buf,
                          int offset,
                          int length,
                          long seqId)
```
  - ByteBufferKeyValue
```
public ByteBufferKeyValue(ByteBuffer buf,
                          int offset,
                          int length)
```
- Method Detail
  - getBuffer
```
public ByteBuffer getBuffer()
```
  - getOffset
```
public int getOffset()
```
  - getRowArray
```
public byte[] getRowArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Short.MAX_VALUE which is 32,767 bytes.
    
    Specified by:
    
    getRowArray in interface Cell
    
    Returns:
    
    The array containing the row bytes.
  - getRowOffset
```
public int getRowOffset()
```
    Specified by:
    
    getRowOffset in interface Cell
    
    Returns:
    
    Array index of first row byte
  - getRowLength
```
public short getRowLength()
```
    Specified by:
    
    getRowLength in interface Cell
    
    Returns:
    
    Number of row bytes. Must be < rowArray.length - offset.
  - getFamilyArray
```
public byte[] getFamilyArray()
```
    Description copied from interface: Cell
    
    Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array. Max length is Byte.MAX_VALUE, which is 127 bytes.
    
    Specified by:
    
    getFamilyArray in interface Cell
    
    Returns:
    
    the array containing the family bytes.
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Specified by:
    
    getFamilyOffset in interface Cell
    
    Returns:
    
    Array index of first family byte
  - getFamilyLength
```
public byte getFamilyLength()
```
    Specified by:
    
    getFamilyLength in interface Cell
    
    Returns:
    
    Number of family bytes. Must be < familyArray.length - offset.
  - getQualifierArray
```
public byte[] getQualifierArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array.
    
    Specified by:
    
    getQualifierArray in interface Cell
    
    Returns:
    
    The array containing the qualifier bytes.
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Specified by:
    
    getQualifierOffset in interface Cell
    
    Returns:
    
    Array index of first qualifier byte
  - getQualifierLength
```
public int getQualifierLength()
```
    Specified by:
    
    getQualifierLength in interface Cell
    
    Returns:
    
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Cell
    
    Returns:
    
    Long value representing time at which this cell was "Put" into the row. Typically represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.
  - getTypeByte
```
public byte getTypeByte()
```
    Specified by:
    
    getTypeByte in interface Cell
    
    Returns:
    
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - getSequenceId
```
public long getSequenceId()
```
    Description copied from interface: Cell
    
    A region-specific unique monotonically increasing sequence ID given to each Cell. It always exists for cells in the memstore but is not retained forever. It will be kept for HConstants.KEEP_SEQID_PERIOD days, but generally becomes irrelevant after the cell's row is no longer involved in any operations that require strict consistency.
    
    Specified by:
    
    getSequenceId in interface Cell
    
    Returns:
    
    seqId (always > 0 if exists), or 0 if it no longer exists
  - setSequenceId
```
public void setSequenceId(long seqId)
```
    Description copied from interface: SettableSequenceId
    
    Sets with the given seqId.
    
    Specified by:
    
    setSequenceId in interface SettableSequenceId
  - getValueArray
```
public byte[] getValueArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Integer.MAX_VALUE which is 2,147,483,647 bytes.
    
    Specified by:
    
    getValueArray in interface Cell
    
    Returns:
    
    The array containing the value bytes.
  - getValueOffset
```
public int getValueOffset()
```
    Specified by:
    
    getValueOffset in interface Cell
    
    Returns:
    
    Array index of first value byte
  - getValueLength
```
public int getValueLength()
```
    Specified by:
    
    getValueLength in interface Cell
    
    Returns:
    
    Number of value bytes. Must be < valueArray.length - offset.
  - getTagsArray
```
public byte[] getTagsArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    Specified by:
    
    getTagsArray in interface Cell
    
    Returns:
    
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Specified by:
    
    getTagsOffset in interface Cell
    
    Returns:
    
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    Description copied from interface: Cell
    
    HBase internally uses 2 bytes to store tags length in Cell. As the tags length is always a non-negative number, to make good use of the sign bit, the max of tags length is defined as TagUtil.MAX_TAGS_LENGTH, which is 2 * Short.MAX_VALUE + 1 = 65535. As a result, the return type is int, because a short is not capable of handling that. Please note that even if the return type is int, the max tags length is far less than Integer.MAX_VALUE.
    
    Specified by:
    
    getTagsLength in interface Cell
    
    Returns:
    
    the total length of the tags in the Cell.
  - getRowByteBuffer
```
public ByteBuffer getRowByteBuffer()
```
    Specified by:
    
    getRowByteBuffer in class ByteBufferCell
    
    Returns:
    
    The ByteBuffer containing the row bytes.
  - getRowPosition
```
public int getRowPosition()
```
    Specified by:
    
    getRowPosition in class ByteBufferCell
    
    Returns:
    
    Position in the ByteBuffer where row bytes start
  - getFamilyByteBuffer
```
public ByteBuffer getFamilyByteBuffer()
```
    Specified by:
    
    getFamilyByteBuffer in class ByteBufferCell
    
    Returns:
    
    The ByteBuffer containing the column family bytes.
  - getFamilyPosition
```
public int getFamilyPosition()
```
    Specified by:
    
    getFamilyPosition in class ByteBufferCell
    
    Returns:
    
    Position in the ByteBuffer where column family bytes start
  - getQualifierByteBuffer
```
public ByteBuffer getQualifierByteBuffer()
```
    Specified by:
    
    getQualifierByteBuffer in class ByteBufferCell
    
    Returns:
    
    The ByteBuffer containing the column qualifier bytes.
  - getQualifierPosition
```
public int getQualifierPosition()
```
    Specified by:
    
    getQualifierPosition in class ByteBufferCell
    
    Returns:
    
    Position in the ByteBuffer where column qualifier bytes start
  - getValueByteBuffer
```
public ByteBuffer getValueByteBuffer()
```
    Specified by:
    
    getValueByteBuffer in class ByteBufferCell
    
    Returns:
    
    The ByteBuffer containing the value bytes.
  - getValuePosition
```
public int getValuePosition()
```
    Specified by:
    
    getValuePosition in class ByteBufferCell
    
    Returns:
    
    Position in the ByteBuffer where value bytes start
  - getTagsByteBuffer
```
public ByteBuffer getTagsByteBuffer()
```
    Specified by:
    
    getTagsByteBuffer in class ByteBufferCell
    
    Returns:
    
    The ByteBuffer containing the tag bytes.
  - getTagsPosition
```
public int getTagsPosition()
```
    Specified by:
    
    getTagsPosition in class ByteBufferCell
    
    Returns:
    
    Position in the ByteBuffer where tag bytes start
  - heapSize
```
public long heapSize()
```
    Specified by:
    
    heapSize in interface HeapSize
    
    Returns:
    
    Approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.
  - write
```
public int write(OutputStream out,
                 boolean withTags)
          throws IOException
```
    Description copied from interface: ExtendedCell
    
    Write this cell to an OutputStream in a KeyValue format.
    KeyValue format
    <4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> <tags>
    
    Specified by:
    
    write in interface ExtendedCell
    
    Parameters:
    
    out - Stream to which cell has to be written
    
    withTags - Whether to write tags.
    
    Returns:
    
    how many bytes are written.
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize(boolean withTags)
```
    Specified by:
    
    getSerializedSize in interface ExtendedCell
    
    Parameters:
    
    withTags - Whether to write tags.
    
    Returns:
    
    Bytes count required to serialize this Cell in a KeyValue format.
    KeyValue format
    <4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> <tags>
  - write
```
public void write(ByteBuffer buf,
                  int offset)
```
    Description copied from interface: ExtendedCell
    
    Write this Cell into the given buf's offset in a KeyValue format.
    
    Specified by:
    
    write in interface ExtendedCell
    
    Parameters:
    
    buf - The buffer where to write the Cell.
    
    offset - The offset within buffer, to write the Cell.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setTimestamp
```
public void setTimestamp(long ts)
                  throws IOException
```
    Description copied from interface: SettableTimestamp
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface SettableTimestamp
    
    Throws:
    
    IOException
  - setTimestamp
```
public void setTimestamp(byte[] ts,
                         int tsOffset)
                  throws IOException
```
    Description copied from interface: SettableTimestamp
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface SettableTimestamp
    
    Parameters:
    
    ts - buffer containing the timestamp value
    
    tsOffset - offset to the new timestamp
    
    Throws:
    
    IOException
  - deepClone
```
public ExtendedCell deepClone()
```
    Description copied from interface: ExtendedCell
    
    Does a deep copy of the contents to a new memory area and returns it as a new cell.
    
    Specified by:
    
    deepClone in interface ExtendedCell
    
    Returns:
    
    The deep cloned cell
  - equals
```
public boolean equals(Object other)
```
    Needed doing 'contains' on List. Only compares the key portion, not the value.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    In line with equals(Object), only uses the key portion, not the value.
    
    Overrides:
    
    hashCode in class Object

Class ByteBufferKeyValue

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.ExtendedCell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.ExtendedCell

Field Detail

buf

offset

length

FIXED_OVERHEAD

Constructor Detail

ByteBufferKeyValue

ByteBufferKeyValue

Method Detail

getBuffer

getOffset

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getSequenceId

setSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getRowByteBuffer

getRowPosition

getFamilyByteBuffer

getFamilyPosition

getQualifierByteBuffer

getQualifierPosition

getValueByteBuffer

getValuePosition

getTagsByteBuffer

getTagsPosition

heapSize

write

getSerializedSize

write

toString

setTimestamp

setTimestamp

deepClone

equals

hashCode