ByteBufferKeyValue (Apache HBase

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

所有已实现的接口:

Cell, ExtendedCell, HeapSize, RawCell

直接已知子类:

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

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.hadoop.hbase.Cell
  Cell.Type

字段概要

字段
限定符和类型字段和说明

protected ByteBuffer buf

static int FIXED_OVERHEAD

protected int length

protected int offset
- 从接口继承的字段 org.apache.hadoop.hbase.ExtendedCell
  CELL_NOT_BASED_ON_CHUNK
- 从接口继承的字段 org.apache.hadoop.hbase.RawCell
  MAX_TAGS_LENGTH

字段
限定符和类型	字段和说明
`protected ByteBuffer`	`buf`
`static int`	`FIXED_OVERHEAD`
`protected int`	`length`
`protected int`	`offset`

构造器概要

构造器
构造器和说明
`ByteBufferKeyValue(ByteBuffer buf, int offset, int length)`
`ByteBufferKeyValue(ByteBuffer buf, int offset, int length, long seqId)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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`	`getFamilyPosition(int familyLengthPosition)`
`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()`
`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)` 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.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.hadoop.hbase.ExtendedCell
getChunkId

从接口继承的方法 org.apache.hadoop.hbase.RawCell
checkForTagsLength, cloneTags, getTag, getTags

从接口继承的方法 org.apache.hadoop.hbase.Cell
getType

- 字段详细资料
  - buf
```
protected final ByteBuffer buf
```
  - offset
```
protected final int offset
```
  - length
```
protected final int length
```
  - FIXED_OVERHEAD
```
public static final int FIXED_OVERHEAD
```
- 构造器详细资料
  - ByteBufferKeyValue
```
public ByteBufferKeyValue(ByteBuffer buf,
                          int offset,
                          int length,
                          long seqId)
```
  - ByteBufferKeyValue
```
public ByteBufferKeyValue(ByteBuffer buf,
                          int offset,
                          int length)
```
- 方法详细资料
  - getBuffer
```
public ByteBuffer getBuffer()
```
  - getOffset
```
public int getOffset()
```
  - getRowArray
```
public byte[] getRowArray()
```
    从接口复制的说明: 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.
    
    返回:
    
    The array containing the row bytes.
  - getRowOffset
```
public int getRowOffset()
```
    返回:
    
    Array index of first row byte
  - getRowLength
```
public short getRowLength()
```
    返回:
    
    Number of row bytes. Must be < rowArray.length - offset.
  - getFamilyArray
```
public byte[] getFamilyArray()
```
    从接口复制的说明: 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.
    
    返回:
    
    the array containing the family bytes.
  - getFamilyOffset
```
public int getFamilyOffset()
```
    返回:
    
    Array index of first family byte
  - getFamilyLength
```
public byte getFamilyLength()
```
    返回:
    
    Number of family bytes. Must be < familyArray.length - offset.
  - getQualifierArray
```
public byte[] getQualifierArray()
```
    从接口复制的说明: Cell
    
    Contiguous raw bytes that may start at any index in the containing array.
    
    返回:
    
    The array containing the qualifier bytes.
  - getQualifierOffset
```
public int getQualifierOffset()
```
    返回:
    
    Array index of first qualifier byte
  - getQualifierLength
```
public int getQualifierLength()
```
    返回:
    
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
  - getTimestamp
```
public long getTimestamp()
```
    返回:
    
    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()
```
    返回:
    
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - getSequenceId
```
public long getSequenceId()
```
    从接口复制的说明: 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.
    
    返回:
    
    seqId (always > 0 if exists), or 0 if it no longer exists
  - setSequenceId
```
public void setSequenceId(long seqId)
```
    从接口复制的说明: ExtendedCell
    
    Sets with the given seqId.
    
    参数:
    
    seqId - sequence ID
  - getValueArray
```
public byte[] getValueArray()
```
    从接口复制的说明: 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.
    
    返回:
    
    The array containing the value bytes.
  - getValueOffset
```
public int getValueOffset()
```
    返回:
    
    Array index of first value byte
  - getValueLength
```
public int getValueLength()
```
    返回:
    
    Number of value bytes. Must be < valueArray.length - offset.
  - getTagsArray
```
public byte[] getTagsArray()
```
    从接口复制的说明: ExtendedCell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    返回:
    
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    返回:
    
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    从接口复制的说明: 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.
    
    返回:
    
    the total length of the tags in the Cell.
  - getRowByteBuffer
```
public ByteBuffer getRowByteBuffer()
```
    指定者:
    
    getRowByteBuffer 在类中 ByteBufferExtendedCell
    
    返回:
    
    The ByteBuffer containing the row bytes.
  - getRowPosition
```
public int getRowPosition()
```
    指定者:
    
    getRowPosition 在类中 ByteBufferExtendedCell
    
    返回:
    
    Position in the ByteBuffer where row bytes start
  - getFamilyByteBuffer
```
public ByteBuffer getFamilyByteBuffer()
```
    指定者:
    
    getFamilyByteBuffer 在类中 ByteBufferExtendedCell
    
    返回:
    
    The ByteBuffer containing the column family bytes.
  - getFamilyPosition
```
public int getFamilyPosition()
```
    指定者:
    
    getFamilyPosition 在类中 ByteBufferExtendedCell
    
    返回:
    
    Position in the ByteBuffer where column family bytes start
  - getFamilyPosition
```
public int getFamilyPosition(int familyLengthPosition)
```
  - getQualifierByteBuffer
```
public ByteBuffer getQualifierByteBuffer()
```
    指定者:
    
    getQualifierByteBuffer 在类中 ByteBufferExtendedCell
    
    返回:
    
    The ByteBuffer containing the column qualifier bytes.
  - getQualifierPosition
```
public int getQualifierPosition()
```
    指定者:
    
    getQualifierPosition 在类中 ByteBufferExtendedCell
    
    返回:
    
    Position in the ByteBuffer where column qualifier bytes start
  - getValueByteBuffer
```
public ByteBuffer getValueByteBuffer()
```
    指定者:
    
    getValueByteBuffer 在类中 ByteBufferExtendedCell
    
    返回:
    
    The ByteBuffer containing the value bytes.
  - getValuePosition
```
public int getValuePosition()
```
    指定者:
    
    getValuePosition 在类中 ByteBufferExtendedCell
    
    返回:
    
    Position in the ByteBuffer where value bytes start
  - getTagsByteBuffer
```
public ByteBuffer getTagsByteBuffer()
```
    指定者:
    
    getTagsByteBuffer 在类中 ByteBufferExtendedCell
    
    返回:
    
    The ByteBuffer containing the tag bytes.
  - getTagsPosition
```
public int getTagsPosition()
```
    指定者:
    
    getTagsPosition 在类中 ByteBufferExtendedCell
    
    返回:
    
    Position in the ByteBuffer where tag bytes start
  - heapSize
```
public long heapSize()
```
    返回:
    
    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
```
    从接口复制的说明: 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>
    
    参数:
    
    out - Stream to which cell has to be written
    
    withTags - Whether to write tags.
    
    返回:
    
    how many bytes are written.
    
    抛出:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize(boolean withTags)
```
    参数:
    
    withTags - Whether to write tags.
    
    返回:
    
    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>
  - getSerializedSize
```
public int getSerializedSize()
```
    返回:
    
    Serialized size (defaults to include tag length).
  - write
```
public void write(ByteBuffer buf,
                  int offset)
```
    从接口复制的说明: ExtendedCell
    
    Write this Cell into the given buf's offset in a KeyValue format.
    
    参数:
    
    buf - The buffer where to write the Cell.
    
    offset - The offset within buffer, to write the Cell.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - setTimestamp
```
public void setTimestamp(long ts)
                  throws IOException
```
    从接口复制的说明: ExtendedCell
    
    Sets with the given timestamp.
    
    参数:
    
    ts - timestamp
    
    抛出:
    
    IOException
  - setTimestamp
```
public void setTimestamp(byte[] ts)
                  throws IOException
```
    从接口复制的说明: ExtendedCell
    
    Sets with the given timestamp.
    
    参数:
    
    ts - buffer containing the timestamp value
    
    抛出:
    
    IOException
  - deepClone
```
public ExtendedCell deepClone()
```
    从接口复制的说明: ExtendedCell
    
    Does a deep copy of the contents to a new memory area and returns it as a new cell.
    
    返回:
    
    The deep cloned cell
  - equals
```
public boolean equals(Object other)
```
    Needed doing 'contains' on List. Only compares the key portion, not the value.
    
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    In line with equals(Object), only uses the key portion, not the value.
    
    覆盖:
    
    hashCode 在类中 Object

类 ByteBufferKeyValue

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.hbase.Cell

字段概要

从接口继承的字段 org.apache.hadoop.hbase.ExtendedCell

从接口继承的字段 org.apache.hadoop.hbase.RawCell

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hadoop.hbase.ExtendedCell

从接口继承的方法 org.apache.hadoop.hbase.RawCell

从接口继承的方法 org.apache.hadoop.hbase.Cell

字段详细资料

buf

offset

length

FIXED_OVERHEAD

构造器详细资料

ByteBufferKeyValue

ByteBufferKeyValue

方法详细资料

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

getFamilyPosition

getQualifierByteBuffer

getQualifierPosition

getValueByteBuffer

getValuePosition

getTagsByteBuffer

getTagsPosition

heapSize

write

getSerializedSize

getSerializedSize

write

toString

setTimestamp

setTimestamp

deepClone

equals

hashCode