CellUtil (Apache HBase 1.4.11 API)

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

```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public final class CellUtil
extends Object
```
Utility methods helpful slinging Cell instances. Some methods below are for internal use only and are marked InterfaceAudience.Private at the method level.

Constructor Summary

Constructors
Constructor and Description

CellUtil()

Constructors
Constructor and Description
`CellUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static byte[]`	`cloneFamily(Cell cell)`
`static byte[]`	`cloneQualifier(Cell cell)`
`static byte[]`	`cloneRow(Cell cell)` get individual arrays for tests
`static byte[]`	`cloneValue(Cell cell)`
`static int`	`copyFamilyTo(Cell cell, byte[] destination, int destinationOffset)`
`static int`	`copyQualifierTo(Cell cell, byte[] destination, int destinationOffset)`
`static int`	`copyRowTo(Cell cell, byte[] destination, int destinationOffset)` copyTo
`static int`	`copyTagTo(Cell cell, byte[] destination, int destinationOffset)` Copies the tags info into the tag portion of the cell
`static int`	`copyValueTo(Cell cell, byte[] destination, int destinationOffset)`
`static Cell`	`createCell(byte[] row)` Create a Cell with specific row.
`static Cell`	`createCell(byte[] row, byte[] value)` Create a Cell with specific row and value.
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier)` Create a Cell with specific row.
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte type, byte[] value)`
`static Cell`	`createCell(byte[] rowArray, int rowOffset, int rowLength, byte[] familyArray, int familyOffset, int familyLength, byte[] qualifierArray, int qualifierOffset, int qualifierLength)`
`static org.apache.hadoop.hbase.CellScanner`	`createCellScanner(Cell[] cellArray)`
`static org.apache.hadoop.hbase.CellScanner`	`createCellScanner(Iterable<Cell> cellIterable)`
`static org.apache.hadoop.hbase.CellScanner`	`createCellScanner(Iterator<Cell> cells)`
`static org.apache.hadoop.hbase.CellScanner`	`createCellScanner(List<? extends org.apache.hadoop.hbase.CellScannable> cellScannerables)`
`static org.apache.hadoop.hbase.CellScanner`	`createCellScanner(NavigableMap<byte[],List<Cell>> map)` Flatten the map of cells out under the CellScanner
`static boolean`	`equals(Cell a, Cell b)` equals
`static long`	`estimatedHeapSizeOf(Cell cell)` This is an estimate of the heap space occupied by a cell.
`static long`	`estimatedHeapSizeOfWithoutTags(Cell cell)` Deprecated.
`static int`	`estimatedSerializedSizeOf(Cell cell)`
`static int`	`estimatedSerializedSizeOfKey(Cell cell)` Calculates the serialized key size.
`static int`	`estimatedSizeOf(Cell cell)` Deprecated. please use estimatedSerializedSizeOf(Cell)
`static ByteRange`	`fillFamilyRange(Cell cell, ByteRange range)`
`static ByteRange`	`fillQualifierRange(Cell cell, ByteRange range)`
`static ByteRange`	`fillRowRange(Cell cell, ByteRange range)` ByteRange
`static ByteRange`	`fillTagRange(Cell cell, ByteRange range)`
`static ByteRange`	`fillValueRange(Cell cell, ByteRange range)`
`static int`	`findCommonPrefixInFlatKey(Cell c1, Cell c2, boolean bypassFamilyCheck, boolean withTsType)` Find length of common prefix in keys of the cells, considering key as byte[] if serialized in `KeyValue`.
`static String`	`getCellKeyAsString(Cell cell)`
`static byte[]`	`getCellKeySerializedAsKeyValueKey(Cell cell)` This method exists just to encapsulate how we serialize keys.
`static ByteBuffer`	`getQualifierBufferShallowCopy(Cell cell)`
`static byte`	`getRowByte(Cell cell, int index)` misc
`static byte[]`	`getTagArray(Cell cell)` Returns tag value in a new byte array.
`static ByteBuffer`	`getValueBufferShallowCopy(Cell cell)`
`static boolean`	`isDelete(byte type)`
`static boolean`	`isDelete(Cell cell)`
`static boolean`	`isDeleteColumnOrFamily(Cell cell)`
`static boolean`	`isDeleteColumns(Cell cell)`
`static boolean`	`isDeleteColumnVersion(Cell cell)`
`static boolean`	`isDeleteFamily(Cell cell)`
`static boolean`	`isDeleteFamilyVersion(Cell cell)`
`static boolean`	`isDeleteType(Cell cell)`
`static boolean`	`matchingColumn(Cell left, byte[] fam, byte[] qual)`
`static boolean`	`matchingColumn(Cell left, byte[] fam, int foffset, int flength, byte[] qual, int qoffset, int qlength)`
`static boolean`	`matchingColumn(Cell left, Cell right)`
`static boolean`	`matchingFamily(Cell left, byte[] buf)`
`static boolean`	`matchingFamily(Cell left, byte[] buf, int offset, int length)`
`static boolean`	`matchingFamily(Cell left, Cell right)`
`static boolean`	`matchingQualifier(Cell left, byte[] buf)`
`static boolean`	`matchingQualifier(Cell left, byte[] buf, int offset, int length)`
`static boolean`	`matchingQualifier(Cell left, Cell right)`
`static boolean`	`matchingRow(Cell left, byte[] buf)`
`static boolean`	`matchingRow(Cell left, byte[] buf, int offset, int length)`
`static boolean`	`matchingRow(Cell left, Cell right)`
`static boolean`	`matchingRowColumn(Cell left, Cell right)` Compares the row and column of two keyvalues for equality
`static boolean`	`matchingTimestamp(Cell a, Cell b)`
`static boolean`	`matchingType(Cell a, Cell b)`
`static boolean`	`matchingValue(Cell left, byte[] buf)`
`static boolean`	`matchingValue(Cell left, Cell right)`
`static boolean`	`overlappingKeys(byte[] start1, byte[] end1, byte[] start2, byte[] end2)` Returns true if the first range start1...end1 overlaps with the second range start2...end2, assuming the byte arrays represent row keys
`static void`	`setTimestamp(Cell cell, byte[] ts, int tsOffset)` Sets the given timestamp to the cell.
`static void`	`setTimestamp(Cell cell, long ts)` Sets the given timestamp to the cell.
`static Iterator<org.apache.hadoop.hbase.Tag>`	`tagsIterator(byte[] tags, int offset, int length)` Util method to iterate through the tags
`static String`	`toString(Cell cell, boolean verbose)` Returns a string representation of the cell
`static boolean`	`updateLatestStamp(Cell cell, byte[] ts, int tsOffset)` Sets the given timestamp to the cell iff current timestamp is `HConstants.LATEST_TIMESTAMP`.
`static boolean`	`updateLatestStamp(Cell cell, long ts)` Sets the given timestamp to the cell iff current timestamp is `HConstants.LATEST_TIMESTAMP`.
`static void`	`writeFlatKey(Cell cell, DataOutputStream out)` Writes the Cell's key part as it would have serialized in a KeyValue.
`static void`	`writeRowKeyExcludingCommon(Cell cell, short rLen, int commonPrefix, DataOutputStream out)` Write rowkey excluding the common part.

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

Constructor Detail
- CellUtil
```
public CellUtil()
```

Method Detail

fillRowRange

public static ByteRange fillRowRange(Cell cell,
                     ByteRange range)

ByteRange

fillFamilyRange

public static ByteRange fillFamilyRange(Cell cell,
                        ByteRange range)

fillQualifierRange

public static ByteRange fillQualifierRange(Cell cell,
                           ByteRange range)

fillValueRange

public static ByteRange fillValueRange(Cell cell,
                       ByteRange range)

fillTagRange

public static ByteRange fillTagRange(Cell cell,
                     ByteRange range)

cloneRow

public static byte[] cloneRow(Cell cell)

get individual arrays for tests

cloneFamily

public static byte[] cloneFamily(Cell cell)

cloneQualifier

public static byte[] cloneQualifier(Cell cell)

cloneValue

public static byte[] cloneValue(Cell cell)

getTagArray
```
public static byte[] getTagArray(Cell cell)
```
Returns tag value in a new byte array. If server-side, use Tag.getBuffer() with appropriate Tag.getTagOffset() and Tag.getTagLength() instead to save on allocations.

Parameters:
cell -

Returns:
tag value in a new byte array.

copyRowTo

public static int copyRowTo(Cell cell,
            byte[] destination,
            int destinationOffset)

copyTo

copyFamilyTo

public static int copyFamilyTo(Cell cell,
               byte[] destination,
               int destinationOffset)

copyQualifierTo

public static int copyQualifierTo(Cell cell,
                  byte[] destination,
                  int destinationOffset)

copyValueTo

public static int copyValueTo(Cell cell,
              byte[] destination,
              int destinationOffset)

copyTagTo
```
public static int copyTagTo(Cell cell,
            byte[] destination,
            int destinationOffset)
```
Copies the tags info into the tag portion of the cell

Parameters:
cell -
destination -
destinationOffset -

Returns:
position after tags

getRowByte

public static byte getRowByte(Cell cell,
              int index)

misc

getValueBufferShallowCopy

public static ByteBuffer getValueBufferShallowCopy(Cell cell)

getQualifierBufferShallowCopy

public static ByteBuffer getQualifierBufferShallowCopy(Cell cell)

createCell

public static Cell createCell(byte[] row,
              byte[] family,
              byte[] qualifier,
              long timestamp,
              byte type,
              byte[] value)

createCell

public static Cell createCell(byte[] rowArray,
              int rowOffset,
              int rowLength,
              byte[] familyArray,
              int familyOffset,
              int familyLength,
              byte[] qualifierArray,
              int qualifierOffset,
              int qualifierLength)

createCell
```
public static Cell createCell(byte[] row)
```
Create a Cell with specific row. Other fields defaulted.

Parameters:
row -

Returns:
Cell with passed row but all other fields are arbitrary

createCell
```
public static Cell createCell(byte[] row,
              byte[] value)
```
Create a Cell with specific row and value. Other fields are defaulted.

Parameters:
row -
value -

Returns:
Cell with passed row and value but all other fields are arbitrary

createCell
```
public static Cell createCell(byte[] row,
              byte[] family,
              byte[] qualifier)
```
Create a Cell with specific row. Other fields defaulted.

Parameters:
row -
family -
qualifier -

Returns:
Cell with passed row but all other fields are arbitrary

createCellScanner

public static org.apache.hadoop.hbase.CellScanner createCellScanner(List<? extends org.apache.hadoop.hbase.CellScannable> cellScannerables)

Parameters:: cellScannerables -
Returns:: CellScanner interface over cellIterables

createCellScanner

public static org.apache.hadoop.hbase.CellScanner createCellScanner(Iterable<Cell> cellIterable)

Parameters:: cellIterable -
Returns:: CellScanner interface over cellIterable

createCellScanner
```
public static org.apache.hadoop.hbase.CellScanner createCellScanner(Iterator<Cell> cells)
```
Parameters:
cells -

Returns:
CellScanner interface over cellIterable or null if cells is null

createCellScanner

public static org.apache.hadoop.hbase.CellScanner createCellScanner(Cell[] cellArray)

Parameters:: cellArray -
Returns:: CellScanner interface over cellArray

createCellScanner
```
public static org.apache.hadoop.hbase.CellScanner createCellScanner(NavigableMap<byte[],List<Cell>> map)
```
Flatten the map of cells out under the CellScanner

Parameters:
map - Map of Cell Lists; for example, the map of families to Cells that is used inside Put, etc., keeping Cells organized by family.

Returns:
CellScanner interface over cellIterable

matchingRow

public static boolean matchingRow(Cell left,
                  Cell right)

Parameters:: left -; right -
Returns:: True if the rows in left and right Cells match

matchingRow

public static boolean matchingRow(Cell left,
                  byte[] buf)

matchingRow

public static boolean matchingRow(Cell left,
                  byte[] buf,
                  int offset,
                  int length)

matchingFamily

public static boolean matchingFamily(Cell left,
                     Cell right)

matchingFamily

public static boolean matchingFamily(Cell left,
                     byte[] buf)

matchingFamily

public static boolean matchingFamily(Cell left,
                     byte[] buf,
                     int offset,
                     int length)

matchingQualifier

public static boolean matchingQualifier(Cell left,
                        Cell right)

matchingQualifier

public static boolean matchingQualifier(Cell left,
                        byte[] buf)

matchingQualifier

public static boolean matchingQualifier(Cell left,
                        byte[] buf,
                        int offset,
                        int length)

matchingColumn

public static boolean matchingColumn(Cell left,
                     byte[] fam,
                     byte[] qual)

matchingColumn

public static boolean matchingColumn(Cell left,
                     byte[] fam,
                     int foffset,
                     int flength,
                     byte[] qual,
                     int qoffset,
                     int qlength)

matchingColumn

public static boolean matchingColumn(Cell left,
                     Cell right)

matchingValue

public static boolean matchingValue(Cell left,
                    Cell right)

matchingValue

public static boolean matchingValue(Cell left,
                    byte[] buf)

matchingTimestamp

public static boolean matchingTimestamp(Cell a,
                        Cell b)

matchingRowColumn
```
public static boolean matchingRowColumn(Cell left,
                        Cell right)
```
Compares the row and column of two keyvalues for equality

Parameters:
left -
right -

Returns:
True if same row and column.

isDelete
```
public static boolean isDelete(Cell cell)
```
Returns:
True if a delete type, a KeyValue.Type.Delete or a {KeyValue.Type#DeleteFamily} or a KeyValue.Type.DeleteColumn KeyValue type.

isDelete
```
public static boolean isDelete(byte type)
```
Returns:
True if a delete type, a KeyValue.Type.Delete or a {KeyValue.Type#DeleteFamily} or a KeyValue.Type.DeleteColumn KeyValue type.

isDeleteType
```
public static boolean isDeleteType(Cell cell)
```
Returns:
True if this cell is a KeyValue.Type.Delete type.

isDeleteFamily

public static boolean isDeleteFamily(Cell cell)

isDeleteFamilyVersion

public static boolean isDeleteFamilyVersion(Cell cell)

isDeleteColumns

public static boolean isDeleteColumns(Cell cell)

isDeleteColumnVersion

public static boolean isDeleteColumnVersion(Cell cell)

isDeleteColumnOrFamily
```
public static boolean isDeleteColumnOrFamily(Cell cell)
```
Returns:
True if this cell is a delete family or column type.

estimatedSizeOf
```
@Deprecated
public static int estimatedSizeOf(Cell cell)
```
Deprecated. please use estimatedSerializedSizeOf(Cell)

Estimate based on keyvalue's serialization format.

Parameters:
cell -

Returns:
Estimate of the cell size in bytes.

estimatedSerializedSizeOf
```
public static int estimatedSerializedSizeOf(Cell cell)
```
Parameters:
cell -

Returns:
Estimate of the cell size in bytes.

estimatedSerializedSizeOfKey
```
public static int estimatedSerializedSizeOfKey(Cell cell)
```
Calculates the serialized key size. We always serialize in the KeyValue's serialization format.

Parameters:
cell - the cell for which the key size has to be calculated.

Returns:
the key size

estimatedHeapSizeOf
```
public static long estimatedHeapSizeOf(Cell cell)
```
This is an estimate of the heap space occupied by a cell. When the cell is of type HeapSize we call HeapSize.heapSize() so cell can give a correct value. In other cases we just consider the byte occupied by the cell components ie. row, CF, qualifier, timestamp, type, value and tags.

Parameters:
cell -

Returns:
estimate of the heap space

estimatedHeapSizeOfWithoutTags
```
@Deprecated
public static long estimatedHeapSizeOfWithoutTags(Cell cell)
```
Deprecated.

This is a hack that should be removed once we don't care about matching up client- and server-side estimations of cell size. It needed to be backwards compatible with estimations done by older clients. We need to pretend that tags never exist and cells aren't serialized with tag length included. See HBASE-13262 and HBASE-13303

tagsIterator

public static Iterator<org.apache.hadoop.hbase.Tag> tagsIterator(byte[] tags,
                                                 int offset,
                                                 int length)

Util method to iterate through the tags

Parameters:: tags -; offset -; length -
Returns:: iterator for the tags

overlappingKeys

public static boolean overlappingKeys(byte[] start1,
                      byte[] end1,
                      byte[] start2,
                      byte[] end2)

Returns true if the first range start1...end1 overlaps with the second range start2...end2, assuming the byte arrays represent row keys

setTimestamp
```
public static void setTimestamp(Cell cell,
                long ts)
                         throws IOException
```
Sets the given timestamp to the cell.

Parameters:
cell -
ts -

Throws:

IOException - when the passed cell is not of type SettableTimestamp

setTimestamp
```
public static void setTimestamp(Cell cell,
                byte[] ts,
                int tsOffset)
                         throws IOException
```
Sets the given timestamp to the cell.

Parameters:
cell -
ts - buffer containing the timestamp value
tsOffset - offset to the new timestamp

Throws:

IOException - when the passed cell is not of type SettableTimestamp

updateLatestStamp
```
public static boolean updateLatestStamp(Cell cell,
                        long ts)
                                 throws IOException
```
Sets the given timestamp to the cell iff current timestamp is HConstants.LATEST_TIMESTAMP.

Parameters:
cell -
ts -

Returns:
True if cell timestamp is modified.

Throws:

IOException - when the passed cell is not of type SettableTimestamp

updateLatestStamp
```
public static boolean updateLatestStamp(Cell cell,
                        byte[] ts,
                        int tsOffset)
                                 throws IOException
```
Sets the given timestamp to the cell iff current timestamp is HConstants.LATEST_TIMESTAMP.

Parameters:
cell -
ts - buffer containing the timestamp value
tsOffset - offset to the new timestamp

Returns:
True if cell timestamp is modified.

Throws:

IOException - when the passed cell is not of type SettableTimestamp

writeFlatKey
```
public static void writeFlatKey(Cell cell,
                DataOutputStream out)
                         throws IOException
```
Writes the Cell's key part as it would have serialized in a KeyValue. The format is <2 bytes rk len><rk><1 byte cf len><cf><qualifier><8 bytes timestamp><1 byte type>

Parameters:
cell -
out -

Throws:

IOException

getCellKeyAsString
```
public static String getCellKeyAsString(Cell cell)
```
Parameters:
cell -

Returns:
The Key portion of the passed cell as a String.

getCellKeySerializedAsKeyValueKey
```
public static byte[] getCellKeySerializedAsKeyValueKey(Cell cell)
```
This method exists just to encapsulate how we serialize keys. To be replaced by a factory that we query to figure what the Cell implementation is and then, what serialization engine to use and further, how to serialize the key for inclusion in hfile index. TODO.

Parameters:
cell -

Returns:
The key portion of the Cell serialized in the old-school KeyValue way or null if passed a null cell

writeRowKeyExcludingCommon

public static void writeRowKeyExcludingCommon(Cell cell,
                              short rLen,
                              int commonPrefix,
                              DataOutputStream out)
                                       throws IOException

Write rowkey excluding the common part.

Parameters:: cell -; rLen -; commonPrefix -; out -
Throws:: IOException

findCommonPrefixInFlatKey
```
public static int findCommonPrefixInFlatKey(Cell c1,
                            Cell c2,
                            boolean bypassFamilyCheck,
                            boolean withTsType)
```
Find length of common prefix in keys of the cells, considering key as byte[] if serialized in KeyValue. The key format is <2 bytes rk len><rk><1 byte cf len><cf><qualifier><8 bytes timestamp><1 byte type>

Parameters:
c1 - the cell
c2 - the cell
bypassFamilyCheck - when true assume the family bytes same in both cells. Pass it as true when dealing with Cells in same CF so as to avoid some checks
withTsType - when true check timestamp and type bytes also.

Returns:
length of common prefix

toString

public static String toString(Cell cell,
              boolean verbose)

Returns a string representation of the cell

equals

public static boolean equals(Cell a,
             Cell b)

equals

matchingType

public static boolean matchingType(Cell a,
                   Cell b)

Class CellUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CellUtil

Method Detail

fillRowRange

fillFamilyRange

fillQualifierRange

fillValueRange

fillTagRange

cloneRow

cloneFamily

cloneQualifier

cloneValue

getTagArray

copyRowTo

copyFamilyTo

copyQualifierTo

copyValueTo

copyTagTo

getRowByte

getValueBufferShallowCopy

getQualifierBufferShallowCopy

createCell

createCell

createCell

createCell

createCell

createCellScanner

createCellScanner

createCellScanner

createCellScanner

createCellScanner

matchingRow

matchingRow

matchingRow

matchingFamily

matchingFamily

matchingFamily

matchingQualifier

matchingQualifier

matchingQualifier

matchingColumn

matchingColumn

matchingColumn

matchingValue

matchingValue

matchingTimestamp

matchingRowColumn

isDelete

isDelete

isDeleteType

isDeleteFamily

isDeleteFamilyVersion

isDeleteColumns

isDeleteColumnVersion

isDeleteColumnOrFamily

estimatedSizeOf

estimatedSerializedSizeOf

estimatedSerializedSizeOfKey

estimatedHeapSizeOf

estimatedHeapSizeOfWithoutTags

tagsIterator

overlappingKeys

setTimestamp

setTimestamp

updateLatestStamp

updateLatestStamp

writeFlatKey

getCellKeyAsString

getCellKeySerializedAsKeyValueKey

writeRowKeyExcludingCommon

findCommonPrefixInFlatKey

toString

equals

matchingType