KeyValue (Apache HBase 2.1.0-cdh6.3.2 API)

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

All Implemented Interfaces:

Cloneable, Cell, ExtendedCell, HeapSize, RawCell

Direct Known Subclasses:

KeyValue.KeyOnlyKeyValue, NoTagsKeyValue, SizeCachedKeyValue
```
@InterfaceAudience.Private
public class KeyValue
extends Object
implements ExtendedCell, Cloneable
```
An HBase Key/Value. This is the fundamental HBase Type.
HBase applications and users should use the Cell interface and avoid directly using KeyValue and member functions not defined in Cell.
If being used client-side, the primary methods to access individual fields are getRowArray(), getFamilyArray(), getQualifierArray(), getTimestamp(), and getValueArray(). These methods allocate new byte arrays and return copies. Avoid their use server-side.
Instances of this class are immutable. They do not implement Comparable but Comparators are provided. Comparators change with context, whether user table or a catalog table comparison. Its critical you use the appropriate comparator. There are Comparators for normal HFiles, Meta's Hfiles, and bloom filter keys.
KeyValue wraps a byte array and takes offsets and lengths into passed array at where to start interpreting the content as KeyValue. The KeyValue format inside a byte array is: <keylength> <valuelength> <key> <value> Key is further decomposed as: <rowlength> <row> <columnfamilylength> <columnfamily> <columnqualifier> <timestamp> <keytype> The rowlength maximum is Short.MAX_SIZE, column family length maximum is Byte.MAX_SIZE, and column qualifier + key length must be < Integer.MAX_SIZE. The column does not contain the family/qualifier delimiter, COLUMN_FAMILY_DELIMITER
KeyValue can optionally contain Tags. When it contains tags, it is added in the byte array after the value part. The format for this part is: <tagslength><tagsbytes>. tagslength maximum is Short.MAX_SIZE. The tagsbytes contain one or more tags where as each tag is of the form <taglength><tagtype><tagbytes>. tagtype is one byte and taglength maximum is Short.MAX_SIZE and it includes 1 byte type length and actual tag bytes length.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KeyValue.KeyOnlyKeyValue` 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.
`static class`	`KeyValue.KVComparator` Deprecated. : Use `CellComparatorImpl`. Deprecated for hbase 2.0, remove for hbase 3.0.
`static class`	`KeyValue.MetaComparator` Deprecated. : `CellComparatorImpl.META_COMPARATOR` to be used. Deprecated for hbase 2.0, remove for hbase 3.0.
`static interface`	`KeyValue.SamePrefixComparator<T>` Avoids redundant comparisons for better performance.
`static class`	`KeyValue.Type` Key type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`bytes`
`static byte[]`	`COLUMN_FAMILY_DELIM_ARRAY`
`static char`	`COLUMN_FAMILY_DELIMITER` Colon character in UTF-8
`static KeyValue.KVComparator`	`COMPARATOR` Deprecated. Use `CellComparator.getInstance()` instead. Deprecated for hbase 2.0, remove for hbase 3.0.
`static int`	`FAMILY_LENGTH_SIZE` Size of the family length field in bytes
`static int`	`FIXED_OVERHEAD`
`static int`	`KEY_INFRASTRUCTURE_SIZE`
`static int`	`KEY_LENGTH_SIZE` Size of the key length field in bytes
`static int`	`KEYVALUE_INFRASTRUCTURE_SIZE`
`static int`	`KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE`
`protected int`	`length`
`static KeyValue`	`LOWESTKEY` Lowest possible key.
`static KeyValue.KVComparator`	`META_COMPARATOR` Deprecated. Use `CellComparatorImpl.META_COMPARATOR` instead. Deprecated for hbase 2.0, remove for hbase 3.0.
`protected int`	`offset`
`static int`	`ROW_KEY_OFFSET`
`static int`	`ROW_LENGTH_SIZE` Size of the row length field in bytes
`static int`	`ROW_OFFSET`
`static int`	`TAGS_LENGTH_SIZE` Size of the tags length field in bytes
`static int`	`TIMESTAMP_SIZE` Size of the timestamp field in bytes
`static int`	`TIMESTAMP_TYPE_SIZE`
`static int`	`TYPE_SIZE` Size of the key type field in bytes

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

Constructor Summary

Constructors
Constructor and Description
`KeyValue()` Writable Constructor -- DO NOT USE
`KeyValue(byte[] bytes)` Creates a KeyValue from the start of the specified byte array.
`KeyValue(byte[] row, byte[] family, byte[] qualifier)` Constructs KeyValue structure filled with null value.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, byte[] value)` Constructs KeyValue structure as a put filled with specified values and LATEST_TIMESTAMP.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, byte[] tags)`
`KeyValue(byte[] row, byte[] family, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, List<Tag> tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte[] value)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte[] value, List<Tag> tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte[] value, Tag[] tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value, byte[] tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value, List<Tag> tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] bytes, int offset)` Creates a KeyValue from the specified byte array and offset.
`KeyValue(byte[] buffer, int boffset, byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, Tag[] tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] bytes, int offset, int length)` Creates a KeyValue from the specified byte array, starting at offset, and for length `length`.
`KeyValue(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, byte[] tags, int tagsOffset, int tagsLength)`
`KeyValue(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, List<Tag> tags)` Constructs KeyValue structure filled with specified values.
`KeyValue(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, ByteBuffer qualifier, long ts, KeyValue.Type type, ByteBuffer value, List<Tag> tags)`
`KeyValue(byte[] bytes, int offset, int length, long ts)` Creates a KeyValue from the specified byte array, starting at offset, and for length `length`.
`KeyValue(byte[] row, long timestamp)` Constructs KeyValue structure filled with null value.
`KeyValue(byte[] row, long timestamp, KeyValue.Type type)` Constructs KeyValue structure filled with null value.
`KeyValue(Cell c)`
`KeyValue(int rlength, int flength, int qlength, long timestamp, KeyValue.Type type, int vlength)` Constructs an empty KeyValue structure, with specified sizes.
`KeyValue(int rlength, int flength, int qlength, long timestamp, KeyValue.Type type, int vlength, int tagsLength)` Constructs an empty KeyValue structure, with specified sizes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`KeyValue`	`clone()` Clones a KeyValue.
`static KeyValue`	`create(DataInput in)`
`static KeyValue`	`create(int length, DataInput in)` Create a KeyValue reading `length` from `in`
`KeyValue`	`createKeyOnly(boolean lenAsVal)` Creates a new KeyValue that only contains the key portion (the value is set to be null).
`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.
`byte[]`	`getBuffer()` To be used only in tests where the Cells are clearly assumed to be of type KeyValue and that we need access to the backing array to do some test case related assertions.
`static int`	`getDelimiter(byte[] b, int offset, int length, int delimiter)`
`static int`	`getDelimiterInReverse(byte[] b, int offset, int length, int delimiter)` Find index of passed delimiter walking from end of buffer backwards.
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`byte`	`getFamilyLength()`
`byte`	`getFamilyLength(int foffset)`
`int`	`getFamilyOffset()`
`byte[]`	`getKey()` Do not use unless you have to.
`static long`	`getKeyDataStructureSize(int rlength, int flength, int qlength)` Computes the number of bytes that a `KeyValue` instance with the provided characteristics would take up in its underlying data structure for the key.
`int`	`getKeyLength()`
`int`	`getKeyOffset()`
`String`	`getKeyString()`
`static long`	`getKeyValueDataStructureSize(int klength, int vlength, int tagsLength)` Computes the number of bytes that a `KeyValue` instance with the provided characteristics would take up for its underlying data structure.
`static long`	`getKeyValueDataStructureSize(int rlength, int flength, int qlength, int vlength)` Computes the number of bytes that a `KeyValue` instance with the provided characteristics would take up for its underlying data structure.
`static long`	`getKeyValueDataStructureSize(int rlength, int flength, int qlength, int vlength, int tagsLength)` Computes the number of bytes that a `KeyValue` instance with the provided characteristics would take up for its underlying data structure.
`int`	`getLength()`
`int`	`getOffset()`
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()`
`int`	`getQualifierOffset()`
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`short`	`getRowLength()`
`int`	`getRowOffset()`
`long`	`getSequenceId()` used to achieve atomic operations in the memstore.
`int`	`getSerializedSize(boolean withTags)`
`byte[]`	`getTagsArray()` Contiguous raw bytes representing tags that may start at any index in the containing array.
`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 `equals(Object)`, only uses the key portion, not the value.
`long`	`heapSize()` HeapSize implementation We do not count the bytes in the rowCache because it should be empty for a KeyValue in the MemStore.
`static String`	`humanReadableTimestamp(long timestamp)`
`boolean`	`isLatestTimestamp()`
`static String`	`keyToString(byte[] k)`
`static String`	`keyToString(byte[] b, int o, int l)` Use for logging.
`static long`	`oswrite(KeyValue kv, OutputStream out, boolean withTags)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use `write(OutputStream, boolean)`
`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.
`KeyValue`	`shallowCopy()` Creates a shallow copy of this KeyValue, reusing the data byte buffer.
`String`	`toString()`
`Map<String,Object>`	`toStringMap()` Produces a string map for this key/value pair.
`boolean`	`updateLatestStamp(byte[] now)`
`void`	`write(ByteBuffer buf, int offset)` Write this Cell into the given buf's offset in a `KeyValue` format.
`static long`	`write(KeyValue kv, DataOutput out)` Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.
`int`	`write(OutputStream out, boolean withTags)` Write this cell to an OutputStream in a `KeyValue` format.
`static int`	`writeByteArray(byte[] buffer, int boffset, byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength, Tag[] tags)` Write KeyValue format into the provided byte array.

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

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

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

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

- Field Detail
  - FIXED_OVERHEAD
```
public static final int FIXED_OVERHEAD
```
  - COLUMN_FAMILY_DELIMITER
```
public static final char COLUMN_FAMILY_DELIMITER
```
    Colon character in UTF-8
    
    See Also:
    
    Constant Field Values
  - COLUMN_FAMILY_DELIM_ARRAY
```
public static final byte[] COLUMN_FAMILY_DELIM_ARRAY
```
  - COMPARATOR
```
@Deprecated
public static final KeyValue.KVComparator COMPARATOR
```
    Deprecated. Use CellComparator.getInstance() instead. Deprecated for hbase 2.0, remove for hbase 3.0.
    
    Comparator for plain key/values; i.e. non-catalog table key/values. Works on Key portion of KeyValue only.
  - META_COMPARATOR
```
@Deprecated
public static final KeyValue.KVComparator META_COMPARATOR
```
    Deprecated. Use CellComparatorImpl.META_COMPARATOR instead. Deprecated for hbase 2.0, remove for hbase 3.0.
    
    A KeyValue.KVComparator for hbase:meta catalog table KeyValues.
  - KEY_LENGTH_SIZE
```
public static final int KEY_LENGTH_SIZE
```
    Size of the key length field in bytes
    
    See Also:
    
    Constant Field Values
  - TYPE_SIZE
```
public static final int TYPE_SIZE
```
    Size of the key type field in bytes
    
    See Also:
    
    Constant Field Values
  - ROW_LENGTH_SIZE
```
public static final int ROW_LENGTH_SIZE
```
    Size of the row length field in bytes
    
    See Also:
    
    Constant Field Values
  - FAMILY_LENGTH_SIZE
```
public static final int FAMILY_LENGTH_SIZE
```
    Size of the family length field in bytes
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP_SIZE
```
public static final int TIMESTAMP_SIZE
```
    Size of the timestamp field in bytes
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP_TYPE_SIZE
```
public static final int TIMESTAMP_TYPE_SIZE
```
    See Also:
    
    Constant Field Values
  - KEY_INFRASTRUCTURE_SIZE
```
public static final int KEY_INFRASTRUCTURE_SIZE
```
    See Also:
    
    Constant Field Values
  - ROW_OFFSET
```
public static final int ROW_OFFSET
```
    See Also:
    
    Constant Field Values
  - ROW_KEY_OFFSET
```
public static final int ROW_KEY_OFFSET
```
    See Also:
    
    Constant Field Values
  - KEYVALUE_INFRASTRUCTURE_SIZE
```
public static final int KEYVALUE_INFRASTRUCTURE_SIZE
```
    See Also:
    
    Constant Field Values
  - TAGS_LENGTH_SIZE
```
public static final int TAGS_LENGTH_SIZE
```
    Size of the tags length field in bytes
    
    See Also:
    
    Constant Field Values
  - KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE
```
public static final int KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE
```
    See Also:
    
    Constant Field Values
  - LOWESTKEY
```
public static final KeyValue LOWESTKEY
```
    Lowest possible key. Makes a Key with highest possible Timestamp, empty row and column. No key can be equal or lower than this one in memstore or in store file.
  - bytes
```
protected byte[] bytes
```
  - offset
```
protected int offset
```
  - length
```
protected int length
```
- Constructor Detail
  - KeyValue
```
public KeyValue()
```
    Writable Constructor -- DO NOT USE
  - KeyValue
```
public KeyValue(byte[] bytes)
```
    Creates a KeyValue from the start of the specified byte array. Presumes bytes content is formatted as a KeyValue blob.
    
    Parameters:
    
    bytes - byte array
  - KeyValue
```
public KeyValue(byte[] bytes,
                int offset)
```
    Creates a KeyValue from the specified byte array and offset. Presumes bytes content starting at offset is formatted as a KeyValue blob.
    
    Parameters:
    
    bytes - byte array
    
    offset - offset to start of KeyValue
  - KeyValue
```
public KeyValue(byte[] bytes,
                int offset,
                int length)
```
    Creates a KeyValue from the specified byte array, starting at offset, and for length length.
    
    Parameters:
    
    bytes - byte array
    
    offset - offset to start of the KeyValue
    
    length - length of the KeyValue
  - KeyValue
```
public KeyValue(byte[] bytes,
                int offset,
                int length,
                long ts)
```
    Creates a KeyValue from the specified byte array, starting at offset, and for length length.
    
    Parameters:
    
    bytes - byte array
    
    offset - offset to start of the KeyValue
    
    length - length of the KeyValue
    
    ts -
  - KeyValue
```
public KeyValue(byte[] row,
                long timestamp)
```
    Constructs KeyValue structure filled with null value. Sets type to KeyValue.Type.Maximum
    
    Parameters:
    
    row - - row key (arbitrary byte array)
    
    timestamp -
  - KeyValue
```
public KeyValue(byte[] row,
                long timestamp,
                KeyValue.Type type)
```
    Constructs KeyValue structure filled with null value.
    
    Parameters:
    
    row - - row key (arbitrary byte array)
    
    timestamp -
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier)
```
    Constructs KeyValue structure filled with null value. Sets type to KeyValue.Type.Maximum
    
    Parameters:
    
    row - - row key (arbitrary byte array)
    
    family - family name
    
    qualifier - column qualifier
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                byte[] value)
```
    Constructs KeyValue structure as a put filled with specified values and LATEST_TIMESTAMP.
    
    Parameters:
    
    row - - row key (arbitrary byte array)
    
    family - family name
    
    qualifier - column qualifier
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                KeyValue.Type type)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    type - key type
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                byte[] value)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    value - column value
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                byte[] value,
                Tag[] tags)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    value - column value
    
    tags - tags
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                byte[] value,
                List<Tag> tags)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    value - column value
    
    tags - tags non-empty list of tags or null
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                KeyValue.Type type,
                byte[] value)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                List<Tag> tags)
```
    Constructs KeyValue structure filled with specified values.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                byte[] tags)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength,
                List<Tag> tags)
```
    Constructs KeyValue structure filled with specified values.
    
    Parameters:
    
    row - row key
    
    family - family name
    
    qualifier - column qualifier
    
    qoffset - qualifier offset
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    voffset - value offset
    
    vlength - value length
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                byte[] family,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength,
                byte[] tags)
```
    Parameters:
    
    row -
    
    family -
    
    qualifier -
    
    qoffset -
    
    qlength -
    
    timestamp -
    
    type -
    
    value -
    
    voffset -
    
    vlength -
    
    tags -
  - KeyValue
```
public KeyValue(byte[] row,
                int roffset,
                int rlength,
                byte[] family,
                int foffset,
                int flength,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength)
```
    Constructs KeyValue structure filled with specified values.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    row - row key
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] buffer,
                int boffset,
                byte[] row,
                int roffset,
                int rlength,
                byte[] family,
                int foffset,
                int flength,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength,
                Tag[] tags)
```
    Constructs KeyValue structure filled with specified values. Uses the provided buffer as the data buffer.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    buffer - the bytes buffer to use
    
    boffset - buffer offset
    
    row - row key
    
    roffset - row offset
    
    rlength - row length
    
    family - family name
    
    foffset - family offset
    
    flength - family length
    
    qualifier - column qualifier
    
    qoffset - qualifier offset
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    voffset - value offset
    
    vlength - value length
    
    tags - non-empty list of tags or null
    
    Throws:
    
    IllegalArgumentException - an illegal value was passed or there is insufficient space remaining in the buffer
  - KeyValue
```
public KeyValue(byte[] row,
                int roffset,
                int rlength,
                byte[] family,
                int foffset,
                int flength,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength,
                List<Tag> tags)
```
    Constructs KeyValue structure filled with specified values.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    row - row key
    
    roffset - row offset
    
    rlength - row length
    
    family - family name
    
    foffset - family offset
    
    flength - family length
    
    qualifier - column qualifier
    
    qoffset - qualifier offset
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    voffset - value offset
    
    vlength - value length
    
    tags - tags
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                int roffset,
                int rlength,
                byte[] family,
                int foffset,
                int flength,
                byte[] qualifier,
                int qoffset,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                byte[] value,
                int voffset,
                int vlength,
                byte[] tags,
                int tagsOffset,
                int tagsLength)
```
    Parameters:
    
    row -
    
    roffset -
    
    rlength -
    
    family -
    
    foffset -
    
    flength -
    
    qualifier -
    
    qoffset -
    
    qlength -
    
    timestamp -
    
    type -
    
    value -
    
    voffset -
    
    vlength -
    
    tags -
  - KeyValue
```
public KeyValue(int rlength,
                int flength,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                int vlength)
```
    Constructs an empty KeyValue structure, with specified sizes. This can be used to partially fill up KeyValues.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    rlength - row length
    
    flength - family length
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    vlength - value length
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(int rlength,
                int flength,
                int qlength,
                long timestamp,
                KeyValue.Type type,
                int vlength,
                int tagsLength)
```
    Constructs an empty KeyValue structure, with specified sizes. This can be used to partially fill up KeyValues.
    Column is split into two fields, family and qualifier.
    
    Parameters:
    
    rlength - row length
    
    flength - family length
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    vlength - value length
    
    tagsLength -
    
    Throws:
    
    IllegalArgumentException
  - KeyValue
```
public KeyValue(byte[] row,
                int roffset,
                int rlength,
                byte[] family,
                int foffset,
                int flength,
                ByteBuffer qualifier,
                long ts,
                KeyValue.Type type,
                ByteBuffer value,
                List<Tag> tags)
```
  - KeyValue
```
public KeyValue(Cell c)
```
- Method Detail
  - getKeyValueDataStructureSize
```
public static long getKeyValueDataStructureSize(int rlength,
                                                int flength,
                                                int qlength,
                                                int vlength)
```
    Computes the number of bytes that a KeyValue instance with the provided characteristics would take up for its underlying data structure.
    
    Parameters:
    
    rlength - row length
    
    flength - family length
    
    qlength - qualifier length
    
    vlength - value length
    
    Returns:
    
    the KeyValue data structure length
  - getKeyValueDataStructureSize
```
public static long getKeyValueDataStructureSize(int rlength,
                                                int flength,
                                                int qlength,
                                                int vlength,
                                                int tagsLength)
```
    Computes the number of bytes that a KeyValue instance with the provided characteristics would take up for its underlying data structure.
    
    Parameters:
    
    rlength - row length
    
    flength - family length
    
    qlength - qualifier length
    
    vlength - value length
    
    tagsLength - total length of the tags
    
    Returns:
    
    the KeyValue data structure length
  - getKeyValueDataStructureSize
```
public static long getKeyValueDataStructureSize(int klength,
                                                int vlength,
                                                int tagsLength)
```
    Computes the number of bytes that a KeyValue instance with the provided characteristics would take up for its underlying data structure.
    
    Parameters:
    
    klength - key length
    
    vlength - value length
    
    tagsLength - total length of the tags
    
    Returns:
    
    the KeyValue data structure length
  - getKeyDataStructureSize
```
public static long getKeyDataStructureSize(int rlength,
                                           int flength,
                                           int qlength)
```
    Computes the number of bytes that a KeyValue instance with the provided characteristics would take up in its underlying data structure for the key.
    
    Parameters:
    
    rlength - row length
    
    flength - family length
    
    qlength - qualifier length
    
    Returns:
    
    the key data structure length
  - getSequenceId
```
public long getSequenceId()
```
    used to achieve atomic operations in the memstore.
    
    Specified by:
    
    getSequenceId in interface Cell
    
    Specified by:
    
    getSequenceId in interface ExtendedCell
    
    Returns:
    
    seqId (always > 0 if exists), or 0 if it no longer exists
  - setSequenceId
```
public void setSequenceId(long seqId)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given seqId.
    
    Specified by:
    
    setSequenceId in interface ExtendedCell
    
    Parameters:
    
    seqId - sequence ID
  - writeByteArray
```
public static int writeByteArray(byte[] buffer,
                                 int boffset,
                                 byte[] row,
                                 int roffset,
                                 int rlength,
                                 byte[] family,
                                 int foffset,
                                 int flength,
                                 byte[] qualifier,
                                 int qoffset,
                                 int qlength,
                                 long timestamp,
                                 KeyValue.Type type,
                                 byte[] value,
                                 int voffset,
                                 int vlength,
                                 Tag[] tags)
```
    Write KeyValue format into the provided byte array.
    
    Parameters:
    
    buffer - the bytes buffer to use
    
    boffset - buffer offset
    
    row - row key
    
    roffset - row offset
    
    rlength - row length
    
    family - family name
    
    foffset - family offset
    
    flength - family length
    
    qualifier - column qualifier
    
    qoffset - qualifier offset
    
    qlength - qualifier length
    
    timestamp - version timestamp
    
    type - key type
    
    value - column value
    
    voffset - value offset
    
    vlength - value length
    
    Returns:
    
    The number of useful bytes in the buffer.
    
    Throws:
    
    IllegalArgumentException - an illegal value was passed or there is insufficient space remaining in the buffer
  - 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
  - clone
```
public KeyValue clone()
               throws CloneNotSupportedException
```
    Clones a KeyValue. This creates a copy, re-allocating the buffer.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    Fully copied clone of this KeyValue
    
    Throws:
    
    CloneNotSupportedException
  - shallowCopy
```
public KeyValue shallowCopy()
```
    Creates a shallow copy of this KeyValue, reusing the data byte buffer. http://en.wikipedia.org/wiki/Object_copy
    
    Returns:
    
    Shallow copy of this KeyValue
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - keyToString
```
public static String keyToString(byte[] k)
```
    Parameters:
    
    k - Key portion of a KeyValue.
    
    Returns:
    
    Key as a String, empty string if k is null.
  - toStringMap
```
public Map<String,Object> toStringMap()
```
    Produces a string map for this key/value pair. Useful for programmatic use and manipulation of the data stored in an WALKey, for example, printing as JSON. Values are left out due to their tendency to be large. If needed, they can be added manually.
    
    Returns:
    
    the Map<String,?> containing data from this key
  - keyToString
```
public static String keyToString(byte[] b,
                                 int o,
                                 int l)
```
    Use for logging.
    
    Parameters:
    
    b - Key portion of a KeyValue.
    
    o - Offset to start of key
    
    l - Length of key.
    
    Returns:
    
    Key as a String.
  - humanReadableTimestamp
```
public static String humanReadableTimestamp(long timestamp)
```
  - getBuffer
```
public byte[] getBuffer()
```
    To be used only in tests where the Cells are clearly assumed to be of type KeyValue and that we need access to the backing array to do some test case related assertions.
    
    Returns:
    
    The byte array backing this KeyValue.
  - getOffset
```
public int getOffset()
```
    Returns:
    
    Offset into getBuffer() at which this KeyValue starts.
  - getLength
```
public int getLength()
```
    Returns:
    
    Length of bytes this KeyValue occupies in getBuffer().
  - getKeyOffset
```
public int getKeyOffset()
```
    Returns:
    
    Key offset in backing buffer..
  - getKeyString
```
public String getKeyString()
```
  - getKeyLength
```
public int getKeyLength()
```
    Returns:
    
    Length of key portion.
  - 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 backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getValueOffset
```
public int getValueOffset()
```
    Specified by:
    
    getValueOffset in interface Cell
    
    Returns:
    
    the value offset
  - getValueLength
```
public int getValueLength()
```
    Specified by:
    
    getValueLength in interface Cell
    
    Returns:
    
    Value length
  - 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 backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getRowOffset
```
public int getRowOffset()
```
    Specified by:
    
    getRowOffset in interface Cell
    
    Returns:
    
    Row offset
  - getRowLength
```
public short getRowLength()
```
    Specified by:
    
    getRowLength in interface Cell
    
    Returns:
    
    Row length
  - 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 backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Specified by:
    
    getFamilyOffset in interface Cell
    
    Returns:
    
    Family offset
  - getFamilyLength
```
public byte getFamilyLength()
```
    Specified by:
    
    getFamilyLength in interface Cell
    
    Returns:
    
    Family length
  - getFamilyLength
```
public byte getFamilyLength(int foffset)
```
    Returns:
    
    Family length
  - 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 backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Specified by:
    
    getQualifierOffset in interface Cell
    
    Returns:
    
    Qualifier offset
  - getQualifierLength
```
public int getQualifierLength()
```
    Specified by:
    
    getQualifierLength in interface Cell
    
    Returns:
    
    Qualifier length
  - getTimestampOffset
```
public int getTimestampOffset()
```
    Returns:
    
    Timestamp offset
  - isLatestTimestamp
```
public boolean isLatestTimestamp()
```
    Returns:
    
    True if this KeyValue has a LATEST_TIMESTAMP timestamp.
  - updateLatestStamp
```
public boolean updateLatestStamp(byte[] now)
```
    Parameters:
    
    now - Time to set into this IFF timestamp == HConstants.LATEST_TIMESTAMP (else, its a noop).
    
    Returns:
    
    True is we modified this.
  - setTimestamp
```
public void setTimestamp(long ts)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - timestamp
  - setTimestamp
```
public void setTimestamp(byte[] ts)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - buffer containing the timestamp value
  - getKey
```
public byte[] getKey()
```
    Do not use unless you have to. Used internally for compacting and testing. Use getRowArray(), getFamilyArray(), getQualifierArray(), and getValueArray() if accessing a KeyValue client-side.
    
    Returns:
    
    Copy of the key portion only.
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Cell
    
    Returns:
    
    Timestamp
  - getTypeByte
```
public byte getTypeByte()
```
    Specified by:
    
    getTypeByte in interface Cell
    
    Specified by:
    
    getTypeByte in interface ExtendedCell
    
    Returns:
    
    KeyValue.TYPE byte representation
  - getTagsOffset
```
public int getTagsOffset()
```
    This returns the offset where the tag actually starts.
    
    Specified by:
    
    getTagsOffset in interface Cell
    
    Specified by:
    
    getTagsOffset in interface ExtendedCell
    
    Returns:
    
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    This returns the total length of the tag bytes
    
    Specified by:
    
    getTagsLength in interface Cell
    
    Specified by:
    
    getTagsLength in interface ExtendedCell
    
    Returns:
    
    the total length of the tags in the Cell.
  - getTagsArray
```
public byte[] getTagsArray()
```
    Description copied from interface: ExtendedCell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    Specified by:
    
    getTagsArray in interface Cell
    
    Specified by:
    
    getTagsArray in interface ExtendedCell
    
    Returns:
    
    the backing array of the entire KeyValue (all KeyValue fields are in a single array)
  - createKeyOnly
```
public KeyValue createKeyOnly(boolean lenAsVal)
```
    Creates a new KeyValue that only contains the key portion (the value is set to be null). TODO only used by KeyOnlyFilter -- move there.
    
    Parameters:
    
    lenAsVal - replace value with the actual value length (false=empty)
  - getDelimiter
```
public static int getDelimiter(byte[] b,
                               int offset,
                               int length,
                               int delimiter)
```
    Parameters:
    
    b -
    
    delimiter -
    
    Returns:
    
    Index of delimiter having started from start of b moving rightward.
  - getDelimiterInReverse
```
public static int getDelimiterInReverse(byte[] b,
                                        int offset,
                                        int length,
                                        int delimiter)
```
    Find index of passed delimiter walking from end of buffer backwards.
    
    Parameters:
    
    b -
    
    delimiter -
    
    Returns:
    
    Index of delimiter
  - create
```
public static KeyValue create(DataInput in)
                       throws IOException
```
    Parameters:
    
    in - Where to read bytes from. Creates a byte array to hold the KeyValue backing bytes copied from the steam.
    
    Returns:
    
    KeyValue created by deserializing from in OR if we find a length of zero, we will return null which can be useful marking a stream as done.
    
    Throws:
    
    IOException
  - create
```
public static KeyValue create(int length,
                              DataInput in)
                       throws IOException
```
    Create a KeyValue reading length from in
    
    Parameters:
    
    length -
    
    in -
    
    Returns:
    
    Created KeyValue OR if we find a length of zero, we will return null which can be useful marking a stream as done.
    
    Throws:
    
    IOException
  - write
```
public static long write(KeyValue kv,
                         DataOutput out)
                  throws IOException
```
    Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.
    
    Parameters:
    
    kv -
    
    out -
    
    Returns:
    
    Length written on stream
    
    Throws:
    
    IOException
    
    See Also:
    
    for the inverse function
  - oswrite
```
@Deprecated
public static long oswrite(KeyValue kv,
                                       OutputStream out,
                                       boolean withTags)
                                throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use write(OutputStream, boolean)
    
    Write out a KeyValue in the manner in which we used to when KeyValue was a Writable but do not require a DataOutput, just take plain OutputStream Named oswrite so does not clash with write(KeyValue, DataOutput)
    
    Parameters:
    
    kv -
    
    out -
    
    withTags -
    
    Returns:
    
    Length written on stream
    
    Throws:
    
    IOException
    
    See Also:
    
    for the inverse function, write(KeyValue, DataOutput), KeyValueUtil.oswrite(Cell, OutputStream, boolean)
  - 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.
  - heapSize
```
public long heapSize()
```
    HeapSize implementation We do not count the bytes in the rowCache because it should be empty for a KeyValue in the MemStore.
    
    Specified by:
    
    heapSize in interface HeapSize
    
    Returns:
    
    Approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.
  - 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

Class KeyValue

Nested Class Summary

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

COLUMN_FAMILY_DELIMITER

COLUMN_FAMILY_DELIM_ARRAY

COMPARATOR

META_COMPARATOR

KEY_LENGTH_SIZE

TYPE_SIZE

ROW_LENGTH_SIZE

FAMILY_LENGTH_SIZE

TIMESTAMP_SIZE

TIMESTAMP_TYPE_SIZE

KEY_INFRASTRUCTURE_SIZE

ROW_OFFSET

ROW_KEY_OFFSET

KEYVALUE_INFRASTRUCTURE_SIZE

TAGS_LENGTH_SIZE

KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE

LOWESTKEY

bytes

offset

length

Constructor Detail

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

KeyValue

Method Detail

getKeyValueDataStructureSize

getKeyValueDataStructureSize

getKeyValueDataStructureSize

getKeyDataStructureSize

getSequenceId

setSequenceId

writeByteArray

equals

hashCode

clone

shallowCopy

toString

keyToString

toStringMap

keyToString

humanReadableTimestamp

getBuffer

getOffset

getLength