KeyValue.KeyOnlyKeyValue (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.KeyValue
- - org.apache.hadoop.hbase.KeyValue.KeyOnlyKeyValue

All Implemented Interfaces:

Cloneable, Cell, HeapSize, SettableSequenceId, SettableTimestamp

Enclosing class:

KeyValue
```
public static class KeyValue.KeyOnlyKeyValue
extends KeyValue
```
A simple form of KeyValue that creates a keyvalue with only the key part of the byte[] Mainly used in places where we need to compare two cells. Avoids copying of bytes In places like block index keys, we need to compare the key byte[] with a cell. Hence create a Keyvalue(aka Cell) that would help in comparing as two cells

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.KeyValue
  KeyValue.KeyOnlyKeyValue, KeyValue.KVComparator, KeyValue.MetaComparator, KeyValue.RawBytesComparator, KeyValue.RowOnlyComparator, KeyValue.SamePrefixComparator<T>, KeyValue.Type

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.KeyValue
  bytes, COLUMN_FAMILY_DELIM_ARRAY, COLUMN_FAMILY_DELIMITER, COMPARATOR, FAMILY_LENGTH_SIZE, KEY_INFRASTRUCTURE_SIZE, KEY_LENGTH_SIZE, KEYVALUE_INFRASTRUCTURE_SIZE, KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE, length, LOWESTKEY, META_COMPARATOR, offset, RAW_COMPARATOR, ROW_LENGTH_SIZE, ROW_OFFSET, TAGS_LENGTH_SIZE, TIMESTAMP_SIZE, TIMESTAMP_TYPE_SIZE, TYPE_SIZE

Constructor Summary

Constructors
Constructor and Description
`KeyValue.KeyOnlyKeyValue()`
`KeyValue.KeyOnlyKeyValue(byte[] b)`
`KeyValue.KeyOnlyKeyValue(byte[] b, int offset, int length)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Needed doing 'contains' on List.
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`byte`	`getFamilyLength()`
`int`	`getFamilyOffset()`
`byte[]`	`getKey()` Do not use unless you have to.
`int`	`getKeyLength()`
`int`	`getKeyOffset()`
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()`
`private int`	`getQualifierLength(int rlength, int flength)`
`int`	`getQualifierOffset()`
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`short`	`getRowLength()`
`int`	`getRowOffset()`
`byte[]`	`getTagsArray()`
`int`	`getTagsLength()` This returns the total length of the tag bytes
`int`	`getTagsOffset()` This returns the offset where the tag actually starts.
`long`	`getTimestamp()`
`int`	`getTimestampOffset()`
`byte`	`getTypeByte()`
`byte[]`	`getValueArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getValueLength()`
`int`	`getValueOffset()`
`int`	`hashCode()` In line with `KeyValue.equals(Object)`, only uses the key portion, not the value.
`void`	`setKey(byte[] key, int offset, int length)` A setter that helps to avoid object creation every time and whenever there is a need to create new KeyOnlyKeyValue.
`String`	`toString()`

Methods inherited from class org.apache.hadoop.hbase.KeyValue
clone, cloneAndAddTags, create, create, createFirstOnRow, createFirstOnRow, createFirstOnRow, createKeyOnly, createKeyValueFromKey, createKeyValueFromKey, createKeyValueFromKey, getBuffer, getDelimiter, getDelimiterInReverse, getFamily, getFamilyLength, getKeyDataStructureSize, getKeyString, getKeyValueDataStructureSize, getKeyValueDataStructureSize, getKeyValueDataStructureSize, getLength, getMvccVersion, getOffset, getQualifier, getRow, getSequenceId, getTags, getTimestamp, getType, getValue, heapSize, heapSizeWithoutTags, humanReadableTimestamp, iscreate, isDelete, isDelete, isLatestTimestamp, keyToString, keyToString, makeColumn, oswrite, oswrite, parseColumn, setSequenceId, setTimestamp, setTimestamp, shallowCopy, toStringMap, updateLatestStamp, write, writeByteArray

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

- Constructor Detail
  - KeyValue.KeyOnlyKeyValue
```
public KeyValue.KeyOnlyKeyValue()
```
  - KeyValue.KeyOnlyKeyValue
```
public KeyValue.KeyOnlyKeyValue(byte[] b)
```
  - KeyValue.KeyOnlyKeyValue
```
public KeyValue.KeyOnlyKeyValue(byte[] b,
                        int offset,
                        int length)
```
- Method Detail
  - getKeyOffset
```
public int getKeyOffset()
```
    Overrides:
    
    getKeyOffset in class KeyValue
    
    Returns:
    Key offset in backing buffer..
  - setKey
```
public void setKey(byte[] key,
          int offset,
          int length)
```
    A setter that helps to avoid object creation every time and whenever there is a need to create new KeyOnlyKeyValue.
    
    Parameters:
    key -
    offset -
    length -
  - getKey
```
public byte[] getKey()
```
    Description copied from class: KeyValue
    
    Do not use unless you have to. Used internally for compacting and testing. Use KeyValue.getRow(), KeyValue.getFamily(), KeyValue.getQualifier(), and KeyValue.getValue() if accessing a KeyValue client-side.
    
    Overrides:
    
    getKey in class KeyValue
    
    Returns:
    Copy of the key portion only.
  - 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
    
    Overrides:
    
    getRowArray in class KeyValue
    
    Returns:
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getRowOffset
```
public int getRowOffset()
```
    Specified by:
    
    getRowOffset in interface Cell
    
    Overrides:
    
    getRowOffset in class KeyValue
    
    Returns:
    Row 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
    
    Overrides:
    
    getFamilyArray in class KeyValue
    
    Returns:
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getFamilyLength
```
public byte getFamilyLength()
```
    Specified by:
    
    getFamilyLength in interface Cell
    
    Overrides:
    
    getFamilyLength in class KeyValue
    
    Returns:
    Family length
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Specified by:
    
    getFamilyOffset in interface Cell
    
    Overrides:
    
    getFamilyOffset in class KeyValue
    
    Returns:
    Family 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
    
    Overrides:
    
    getQualifierArray in class KeyValue
    
    Returns:
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getQualifierLength
```
public int getQualifierLength()
```
    Specified by:
    
    getQualifierLength in interface Cell
    
    Overrides:
    
    getQualifierLength in class KeyValue
    
    Returns:
    Qualifier length
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Specified by:
    
    getQualifierOffset in interface Cell
    
    Overrides:
    
    getQualifierOffset in class KeyValue
    
    Returns:
    Qualifier offset
  - getKeyLength
```
public int getKeyLength()
```
    Overrides:
    
    getKeyLength in class KeyValue
    
    Returns:
    Length of key portion.
  - getRowLength
```
public short getRowLength()
```
    Specified by:
    
    getRowLength in interface Cell
    
    Overrides:
    
    getRowLength in class KeyValue
    
    Returns:
    Row length
  - getTypeByte
```
public byte getTypeByte()
```
    Specified by:
    
    getTypeByte in interface Cell
    
    Overrides:
    
    getTypeByte in class KeyValue
    
    Returns:
    KeyValue.TYPE byte representation
  - getQualifierLength
```
private int getQualifierLength(int rlength,
                     int flength)
```
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Cell
    
    Overrides:
    
    getTimestamp in class KeyValue
    
    Returns:
    Timestamp
  - getTimestampOffset
```
public int getTimestampOffset()
```
    Overrides:
    
    getTimestampOffset in class KeyValue
    
    Returns:
    Timestamp offset
  - getTagsArray
```
public byte[] getTagsArray()
```
    Specified by:
    
    getTagsArray in interface Cell
    
    Overrides:
    
    getTagsArray in class KeyValue
    
    Returns:
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getTagsOffset
```
public int getTagsOffset()
```
    Description copied from class: KeyValue
    
    This returns the offset where the tag actually starts.
    
    Specified by:
    
    getTagsOffset in interface Cell
    
    Overrides:
    
    getTagsOffset in class KeyValue
    
    Returns:
    the first offset where the tags start in the Cell
  - 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
    
    Overrides:
    
    getValueArray in class KeyValue
    
    Returns:
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getValueOffset
```
public int getValueOffset()
```
    Specified by:
    
    getValueOffset in interface Cell
    
    Overrides:
    
    getValueOffset in class KeyValue
    
    Returns:
    the value offset
  - getValueLength
```
public int getValueLength()
```
    Specified by:
    
    getValueLength in interface Cell
    
    Overrides:
    
    getValueLength in class KeyValue
    
    Returns:
    Value length
  - getTagsLength
```
public int getTagsLength()
```
    Description copied from class: KeyValue
    
    This returns the total length of the tag bytes
    
    Specified by:
    
    getTagsLength in interface Cell
    
    Overrides:
    
    getTagsLength in class KeyValue
    
    Returns:
    the total length of the tags in the Cell.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class KeyValue
  - hashCode
```
public int hashCode()
```
    Description copied from class: KeyValue
    
    In line with KeyValue.equals(Object), only uses the key portion, not the value.
    
    Overrides:
    
    hashCode in class KeyValue
  - equals
```
public boolean equals(Object other)
```
    Description copied from class: KeyValue
    
    Needed doing 'contains' on List. Only compares the key portion, not the value.
    
    Overrides:
    
    equals in class KeyValue

Class KeyValue.KeyOnlyKeyValue

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.KeyValue

Field Summary

Fields inherited from class org.apache.hadoop.hbase.KeyValue

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.KeyValue

Methods inherited from class java.lang.Object

Constructor Detail

KeyValue.KeyOnlyKeyValue

KeyValue.KeyOnlyKeyValue

KeyValue.KeyOnlyKeyValue

Method Detail

getKeyOffset

setKey

getKey

getRowArray

getRowOffset

getFamilyArray

getFamilyLength

getFamilyOffset

getQualifierArray

getQualifierLength

getQualifierOffset

getKeyLength

getRowLength

getTypeByte

getQualifierLength

getTimestamp

getTimestampOffset

getTagsArray

getTagsOffset

getValueArray

getValueOffset

getValueLength

getTagsLength

toString

hashCode

equals