ByteBufferKeyOnlyKeyValue (Apache HBase 2.4.0 API)

java.lang.Object
- org.apache.hadoop.hbase.ByteBufferExtendedCell
- - org.apache.hadoop.hbase.ByteBufferKeyOnlyKeyValue

All Implemented Interfaces:

Cell, ExtendedCell, HeapSize, RawCell
```
@InterfaceAudience.Private
public class ByteBufferKeyOnlyKeyValue
extends ByteBufferExtendedCell
```
This is a key only Cell implementation which is identical to KeyValue.KeyOnlyKeyValue with respect to key serialization but have its data in the form of Byte buffer (onheap and offheap).

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Cell
  Cell.Type

Field Summary

Fields
Modifier and Type Field and Description

private ByteBuffer buf

static int FIXED_OVERHEAD

private int length

private int offset

private short rowLen
- Fields inherited from interface org.apache.hadoop.hbase.ExtendedCell
  CELL_NOT_BASED_ON_CHUNK
- Fields inherited from interface org.apache.hadoop.hbase.RawCell
  MAX_TAGS_LENGTH

Fields
Modifier and Type	Field and Description
`private ByteBuffer`	`buf`
`static int`	`FIXED_OVERHEAD`
`private int`	`length`
`private int`	`offset`
`private short`	`rowLen`

Constructor Summary

Constructors
Constructor and Description
`ByteBufferKeyOnlyKeyValue()` Used in cases where we want to avoid lot of garbage by allocating new objects with different keys.
`ByteBufferKeyOnlyKeyValue(ByteBuffer buf, int offset, int length)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`ByteBuffer`	`getFamilyByteBuffer()`
`byte`	`getFamilyLength()`
`private byte`	`getFamilyLength(int famLenPos)`
`private int`	`getFamilyLengthPosition()`
`int`	`getFamilyOffset()`
`int`	`getFamilyPosition()`
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`ByteBuffer`	`getQualifierByteBuffer()`
`int`	`getQualifierLength()`
`private int`	`getQualifierLength(int rlength, int flength)`
`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.
`Optional<Tag>`	`getTag(byte type)` Returns the specific tag of the given type
`Iterator<Tag>`	`getTags()` Creates a list of tags in the current cell
`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()`
`private int`	`getTimestampOffset()`
`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()`
`long`	`heapSize()`
`void`	`setKey(ByteBuffer key, int offset, int length)` A setter that helps to avoid object creation every time and whenever there is a need to create new OffheapKeyOnlyKeyValue.
`void`	`setKey(ByteBuffer key, int offset, int length, short rowLen)` A setter that helps to avoid object creation every time and whenever there is a need to create new OffheapKeyOnlyKeyValue.
`void`	`setSequenceId(long seqId)` Sets with the given seqId.
`void`	`setTimestamp(byte[] ts)` Sets with the given timestamp.
`void`	`setTimestamp(long ts)` Sets with the given timestamp.
`String`	`toString()`

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

Methods inherited from interface org.apache.hadoop.hbase.ExtendedCell
deepClone, getChunkId, getSerializedSize, getSerializedSize, write, write

Methods inherited from interface org.apache.hadoop.hbase.RawCell
checkForTagsLength, cloneTags

Methods inherited from interface org.apache.hadoop.hbase.Cell
getType

- Field Detail
  - FIXED_OVERHEAD
```
public static final int FIXED_OVERHEAD
```
  - buf
```
private ByteBuffer buf
```
  - offset
```
private int offset
```
  - length
```
private int length
```
  - rowLen
```
private short rowLen
```
- Constructor Detail
  - ByteBufferKeyOnlyKeyValue
```
public ByteBufferKeyOnlyKeyValue()
```
    Used in cases where we want to avoid lot of garbage by allocating new objects with different keys. Use the emtpy construtor and set the keys using setKey(ByteBuffer, int, int)
  - ByteBufferKeyOnlyKeyValue
```
public ByteBufferKeyOnlyKeyValue(ByteBuffer buf,
                                 int offset,
                                 int length)
```
- Method Detail
  - setKey
```
public void setKey(ByteBuffer key,
                   int offset,
                   int length)
```
    A setter that helps to avoid object creation every time and whenever there is a need to create new OffheapKeyOnlyKeyValue.
    
    Parameters:
    
    key -
    
    offset -
    
    length -
  - setKey
```
public void setKey(ByteBuffer key,
                   int offset,
                   int length,
                   short rowLen)
```
    A setter that helps to avoid object creation every time and whenever there is a need to create new OffheapKeyOnlyKeyValue.
    
    Parameters:
    
    key - - the key part of the cell
    
    offset - - offset of the cell
    
    length - - length of the cell
    
    rowLen - - the rowlen part of the cell
  - 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.
    
    Returns:
    
    The array containing the row bytes.
  - getRowOffset
```
public int getRowOffset()
```
    Returns:
    
    Array index of first row byte
  - getRowLength
```
public short getRowLength()
```
    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.
    
    Returns:
    
    the array containing the family bytes.
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Returns:
    
    Array index of first family byte
  - getFamilyLength
```
public byte getFamilyLength()
```
    Returns:
    
    Number of family bytes. Must be < familyArray.length - offset.
  - getFamilyLength
```
private byte getFamilyLength(int famLenPos)
```
  - getQualifierArray
```
public byte[] getQualifierArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array.
    
    Returns:
    
    The array containing the qualifier bytes.
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Returns:
    
    Array index of first qualifier byte
  - getQualifierLength
```
public int getQualifierLength()
```
    Returns:
    
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
  - getQualifierLength
```
private int getQualifierLength(int rlength,
                               int flength)
```
  - getTimestamp
```
public long getTimestamp()
```
    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.
  - getTimestampOffset
```
private int getTimestampOffset()
```
  - getTypeByte
```
public byte getTypeByte()
```
    Returns:
    
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - setSequenceId
```
public void setSequenceId(long seqId)
                   throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given seqId.
    
    Parameters:
    
    seqId - sequence ID
    
    Throws:
    
    IOException
  - setTimestamp
```
public void setTimestamp(long ts)
                  throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Parameters:
    
    ts - timestamp
    
    Throws:
    
    IOException
  - setTimestamp
```
public void setTimestamp(byte[] ts)
                  throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Parameters:
    
    ts - buffer containing the timestamp value
    
    Throws:
    
    IOException
  - getSequenceId
```
public long getSequenceId()
```
    Description copied from interface: ExtendedCell
    
    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.
    
    Returns:
    
    seqId (always > 0 if exists), or 0 if it no longer exists
  - 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.
    
    Returns:
    
    The array containing the value bytes.
  - getValueOffset
```
public int getValueOffset()
```
    Returns:
    
    Array index of first value byte
  - getValueLength
```
public int getValueLength()
```
    Returns:
    
    Number of value bytes. Must be < valueArray.length - offset.
  - getTagsArray
```
public byte[] getTagsArray()
```
    Description copied from interface: ExtendedCell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    Returns:
    
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Returns:
    
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    Description copied from interface: ExtendedCell
    
    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 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.
    
    Returns:
    
    the total length of the tags in the Cell.
  - getRowByteBuffer
```
public ByteBuffer getRowByteBuffer()
```
    Specified by:
    
    getRowByteBuffer in class ByteBufferExtendedCell
    
    Returns:
    
    The ByteBuffer containing the row bytes.
  - getRowPosition
```
public int getRowPosition()
```
    Specified by:
    
    getRowPosition in class ByteBufferExtendedCell
    
    Returns:
    
    Position in the ByteBuffer where row bytes start
  - getFamilyByteBuffer
```
public ByteBuffer getFamilyByteBuffer()
```
    Specified by:
    
    getFamilyByteBuffer in class ByteBufferExtendedCell
    
    Returns:
    
    The ByteBuffer containing the column family bytes.
  - getFamilyPosition
```
public int getFamilyPosition()
```
    Specified by:
    
    getFamilyPosition in class ByteBufferExtendedCell
    
    Returns:
    
    Position in the ByteBuffer where column family bytes start
  - getFamilyLengthPosition
```
private int getFamilyLengthPosition()
```
  - getQualifierByteBuffer
```
public ByteBuffer getQualifierByteBuffer()
```
    Specified by:
    
    getQualifierByteBuffer in class ByteBufferExtendedCell
    
    Returns:
    
    The ByteBuffer containing the column qualifier bytes.
  - getQualifierPosition
```
public int getQualifierPosition()
```
    Specified by:
    
    getQualifierPosition in class ByteBufferExtendedCell
    
    Returns:
    
    Position in the ByteBuffer where column qualifier bytes start
  - getValueByteBuffer
```
public ByteBuffer getValueByteBuffer()
```
    Specified by:
    
    getValueByteBuffer in class ByteBufferExtendedCell
    
    Returns:
    
    The ByteBuffer containing the value bytes.
  - getValuePosition
```
public int getValuePosition()
```
    Specified by:
    
    getValuePosition in class ByteBufferExtendedCell
    
    Returns:
    
    Position in the ByteBuffer where value bytes start
  - getTagsByteBuffer
```
public ByteBuffer getTagsByteBuffer()
```
    Specified by:
    
    getTagsByteBuffer in class ByteBufferExtendedCell
    
    Returns:
    
    The ByteBuffer containing the tag bytes.
  - getTagsPosition
```
public int getTagsPosition()
```
    Specified by:
    
    getTagsPosition in class ByteBufferExtendedCell
    
    Returns:
    
    Position in the ByteBuffer where tag bytes start
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTags
```
public Iterator<Tag> getTags()
```
    Description copied from interface: RawCell
    
    Creates a list of tags in the current cell
    
    Returns:
    
    a list of tags
  - getTag
```
public Optional<Tag> getTag(byte type)
```
    Description copied from interface: RawCell
    
    Returns the specific tag of the given type
    
    Parameters:
    
    type - the type of the tag
    
    Returns:
    
    the specific tag if available or null
  - heapSize
```
public long heapSize()
```
    Returns:
    
    Approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.

Class ByteBufferKeyOnlyKeyValue

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Cell

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Field Detail

FIXED_OVERHEAD

buf

offset

length

rowLen

Constructor Detail

ByteBufferKeyOnlyKeyValue

ByteBufferKeyOnlyKeyValue

Method Detail

setKey

setKey

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getQualifierLength

getTimestamp

getTimestampOffset

getTypeByte

setSequenceId

setTimestamp

setTimestamp

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getRowByteBuffer

getRowPosition

getFamilyByteBuffer

getFamilyPosition

getFamilyLengthPosition

getQualifierByteBuffer

getQualifierPosition

getValueByteBuffer

getValuePosition

getTagsByteBuffer

getTagsPosition

toString

getTags

getTag

heapSize