CellUtil (Apache HBase 2.0.6 API)

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

```
@InterfaceAudience.Public
public final class CellUtil
extends Object
```
Utility methods helpful for slinging Cell instances. Some methods below are for internal use only and are marked InterfaceAudience.Private at the method level. Note that all such methods have been marked deprecated in HBase-2.0 which will be subsequently removed in HBase-3.0

Constructor Summary

Constructors
Modifier Constructor and Description

private CellUtil()
Private constructor to keep this class from being instantiated.

Constructors
Modifier	Constructor and Description
`private`	`CellUtil()` Private constructor to keep this class from being instantiated.

Method Summary

All Methods Static Methods Concrete Methods Deprecated 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[]`	`cloneTags(Cell cell)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0. Use `RawCell.cloneTags()`
`static byte[]`	`cloneValue(Cell cell)`
`static int`	`compare(CellComparator comparator, Cell left, byte[] key, int offset, int length)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static int`	`compareColumns(Cell left, byte[] right, int rfoffset, int rflength, int rqoffset, int rqlength)` Compares the cell's column (family and qualifier) with the given byte[]
`static int`	`compareFamilies(Cell left, byte[] right, int roffset, int rlength)` Compares the cell's family with the given byte[]
`static int`	`compareQualifiers(Cell left, byte[] right, int rOffset, int rLength)` Compares the cell's qualifier with the given byte[]
`static int`	`copyFamilyTo(Cell cell, byte[] destination, int destinationOffset)` Copies the family to the given byte[]
`static int`	`copyFamilyTo(Cell cell, ByteBuffer destination, int destinationOffset)` Copies the family to the given bytebuffer
`static int`	`copyQualifierTo(Cell cell, byte[] destination, int destinationOffset)` Copies the qualifier to the given byte[]
`static int`	`copyQualifierTo(Cell cell, ByteBuffer destination, int destinationOffset)` Copies the qualifier to the given bytebuffer
`static byte[]`	`copyRow(Cell cell)` Copies the row to a new byte[]
`static int`	`copyRowTo(Cell cell, byte[] destination, int destinationOffset)` Copies the row to the given byte[]
`static int`	`copyRowTo(Cell cell, ByteBuffer destination, int destinationOffset)` Copies the row to the given bytebuffer
`static int`	`copyTagTo(Cell cell, byte[] destination, int destinationOffset)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static int`	`copyTagTo(Cell cell, ByteBuffer destination, int destinationOffset)` Deprecated. As of HBase-2.0. Will be removed in 3.0.
`static int`	`copyValueTo(Cell cell, byte[] destination, int destinationOffset)` Copies the value to the given byte[]
`static int`	`copyValueTo(Cell cell, ByteBuffer destination, int destinationOffset)` Copies the value to the given bytebuffer
`static Cell`	`createCell(byte[] row)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `CellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] value)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `CellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `CellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte type, byte[] value)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `CellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte type, byte[] value, byte[] tags, long memstoreTS)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `ExtendedCellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte type, byte[] value, long memstoreTS)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `ExtendedCellBuilder` instead
`static Cell`	`createCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value, byte[] tags)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `ExtendedCellBuilder` instead
`static Cell`	`createCell(byte[] rowArray, int rowOffset, int rowLength, byte[] familyArray, int familyOffset, int familyLength, byte[] qualifierArray, int qualifierOffset, int qualifierLength)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `CellBuilder` instead
`static Cell`	`createCell(Cell cell, byte[] tags)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static Cell`	`createCell(Cell cell, byte[] value, byte[] tags)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static Cell`	`createCell(Cell cell, List<Tag> tags)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static CellScanner`	`createCellScanner(Cell[] cellArray)`
`static CellScanner`	`createCellScanner(Iterable<Cell> cellIterable)`
`static CellScanner`	`createCellScanner(Iterator<Cell> cells)`
`static CellScanner`	`createCellScanner(List<? extends CellScannable> cellScannerables)`
`static 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 boolean`	`equalsIgnoreMvccVersion(Cell a, Cell b)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static long`	`estimatedHeapSizeOf(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `RawCell.getTags()`
`static int`	`estimatedSerializedSizeOf(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static int`	`estimatedSerializedSizeOfKey(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static ByteRange`	`fillFamilyRange(Cell cell, ByteRange range)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static ByteRange`	`fillQualifierRange(Cell cell, ByteRange range)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static ByteRange`	`fillRowRange(Cell cell, ByteRange range)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static ByteRange`	`fillTagRange(Cell cell, ByteRange range)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static ByteRange`	`fillValueRange(Cell cell, ByteRange range)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
`static int`	`findCommonPrefixInFlatKey(Cell c1, Cell c2, boolean bypassFamilyCheck, boolean withTsType)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static String`	`getCellKeyAsString(Cell cell)`
`static byte[]`	`getCellKeySerializedAsKeyValueKey(Cell cell)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static ByteBuffer`	`getQualifierBufferShallowCopy(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static byte`	`getRowByte(Cell cell, int index)` Deprecated.
`private static int`	`getSumOfCellElementLengths(Cell cell)`
`private static int`	`getSumOfCellKeyElementLengths(Cell cell)`
`static Tag`	`getTag(Cell cell, byte type)` Deprecated. As of 2.0.0 and will be removed in HBase-3.0.0 Use `RawCell.getTag(byte)`
`static byte[]`	`getTagArray(Cell cell)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static List<Tag>`	`getTags(Cell cell)` Deprecated. As of 2.0.0 and will be removed in 3.0.0
`static ByteBuffer`	`getValueBufferShallowCopy(Cell cell)` Deprecated. As of HBase-2.0. Will be removed in 3.0.
`static boolean`	`isDelete(byte type)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDelete(Cell cell)`
`static boolean`	`isDeleteColumnOrFamily(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDeleteColumns(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDeleteColumnVersion(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDeleteFamily(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDeleteFamilyVersion(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isDeleteType(Cell cell)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`isPut(Cell cell)`
`static byte[]`	`makeColumn(byte[] family, byte[] qualifier)` Makes a column in family:qualifier form from separate byte arrays.
`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)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`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)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`matchingFamily(Cell left, Cell right)`
`static boolean`	`matchingQualifier(Cell left, byte[] buf)` Finds if the qualifier part of the cell and the KV serialized byte[] are equal
`static boolean`	`matchingQualifier(Cell left, byte[] buf, int offset, int length)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
`static boolean`	`matchingQualifier(Cell left, Cell right)`
`static boolean`	`matchingRow(Cell left, byte[] buf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use `#matchingRows(Cell, byte[]))`
`static boolean`	`matchingRow(Cell left, byte[] buf, int offset, int length)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use `matchingRows(Cell, Cell)`
`static boolean`	`matchingRow(Cell left, Cell right)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use `matchingRows(Cell, Cell)`
`static boolean`	`matchingRowColumn(Cell left, Cell right)` Compares the row and column of two keyvalues for equality
`static boolean`	`matchingRowColumnBytes(Cell left, Cell right)`
`static boolean`	`matchingRows(Cell left, byte[] buf)`
`static boolean`	`matchingRows(Cell left, Cell right)` Compares the row of two keyvalues for equality
`static boolean`	`matchingTimestamp(Cell a, Cell b)`
`static boolean`	`matchingType(Cell a, Cell b)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`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)` Deprecated. As of 2.0.0 and will be removed in 3.0.0
`static byte[][]`	`parseColumn(byte[] c)` Splits a column in `family:qualifier` form into separate byte arrays.
`static void`	`setSequenceId(Cell cell, long seqId)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static void`	`setTimestamp(Cell cell, byte[] ts, int tsOffset)` Deprecated. As of HBase-2.0. Will be a LimitedPrivate API in HBase-3.0.
`static void`	`setTimestamp(Cell cell, long ts)` Deprecated. As of HBase-2.0. Will be a LimitedPrivate API in HBase-3.0.
`static Iterator<Tag>`	`tagsIterator(byte[] tags, int offset, int length)` Deprecated. As of 2.0.0 and will be removed in 3.0.0 Instead use `PrivateCellUtil.tagsIterator(Cell)`
`static String`	`toString(Cell cell, boolean verbose)` Returns a string representation of the cell
`static boolean`	`updateLatestStamp(Cell cell, byte[] ts, int tsOffset)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static boolean`	`updateLatestStamp(Cell cell, long ts)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static void`	`writeFlatKey(Cell cell, DataOutputStream out)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static void`	`writeRowKeyExcludingCommon(Cell cell, short rLen, int commonPrefix, DataOutputStream out)` Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
`static void`	`writeRowSkippingBytes(DataOutputStream out, Cell cell, short rlength, int commonPrefix)` Deprecated. As of 2.0. Will be removed in hbase-3.0

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

- Constructor Detail
  - CellUtil
```
private CellUtil()
```
    Private constructor to keep this class from being instantiated.
- Method Detail
  - fillRowRange
```
@Deprecated
public static ByteRange fillRowRange(Cell cell,
                                                 ByteRange range)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
  - fillFamilyRange
```
@Deprecated
public static ByteRange fillFamilyRange(Cell cell,
                                                    ByteRange range)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
  - fillQualifierRange
```
@Deprecated
public static ByteRange fillQualifierRange(Cell cell,
                                                       ByteRange range)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
  - fillValueRange
```
@Deprecated
public static ByteRange fillValueRange(Cell cell,
                                                   ByteRange range)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
  - fillTagRange
```
@Deprecated
public static ByteRange fillTagRange(Cell cell,
                                                 ByteRange range)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
  - 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)
```
  - cloneTags
```
@Deprecated
public static byte[] cloneTags(Cell cell)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0. Use RawCell.cloneTags()
  - getTagArray
```
@Deprecated
public static byte[] getTagArray(Cell cell)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    Returns tag value in a new byte array. If server-side, use Tag.getValueArray() with appropriate Tag.getValueOffset() and Tag.getValueLength() instead to save on allocations.
    
    Parameters:
    
    cell -
    
    Returns:
    
    tag value in a new byte array.
  - makeColumn
```
public static byte[] makeColumn(byte[] family,
                                byte[] qualifier)
```
    Makes a column in family:qualifier form from separate byte arrays.
    Not recommended for usage as this is old-style API.
    
    Parameters:
    
    family -
    
    qualifier -
    
    Returns:
    
    family:qualifier
  - parseColumn
```
public static byte[][] parseColumn(byte[] c)
```
    Splits a column in family:qualifier form into separate byte arrays. An empty qualifier (ie, fam:) is parsed as { fam, EMPTY_BYTE_ARRAY } while no delimiter (ie, fam) is parsed as an array of one element, { fam }.
    Don't forget, HBase DOES support empty qualifiers. (see HBASE-9549)
    
    Not recommend to be used as this is old-style API.
    
    Parameters:
    
    c - The column.
    
    Returns:
    
    The parsed column.
  - copyRowTo
```
public static int copyRowTo(Cell cell,
                            byte[] destination,
                            int destinationOffset)
```
    Copies the row to the given byte[]
    
    Parameters:
    
    cell - the cell whose row has to be copied
    
    destination - the destination byte[] to which the row has to be copied
    
    destinationOffset - the offset in the destination byte[]
    
    Returns:
    
    the offset of the byte[] after the copy has happened
  - copyRowTo
```
public static int copyRowTo(Cell cell,
                            ByteBuffer destination,
                            int destinationOffset)
```
    Copies the row to the given bytebuffer
    
    Parameters:
    
    cell - cell the cell whose row has to be copied
    
    destination - the destination bytebuffer to which the row has to be copied
    
    destinationOffset - the offset in the destination byte[]
    
    Returns:
    
    the offset of the bytebuffer after the copy has happened
  - copyRow
```
public static byte[] copyRow(Cell cell)
```
    Copies the row to a new byte[]
    
    Parameters:
    
    cell - the cell from which row has to copied
    
    Returns:
    
    the byte[] containing the row
  - copyFamilyTo
```
public static int copyFamilyTo(Cell cell,
                               byte[] destination,
                               int destinationOffset)
```
    Copies the family to the given byte[]
    
    Parameters:
    
    cell - the cell whose family has to be copied
    
    destination - the destination byte[] to which the family has to be copied
    
    destinationOffset - the offset in the destination byte[]
    
    Returns:
    
    the offset of the byte[] after the copy has happened
  - copyFamilyTo
```
public static int copyFamilyTo(Cell cell,
                               ByteBuffer destination,
                               int destinationOffset)
```
    Copies the family to the given bytebuffer
    
    Parameters:
    
    cell - the cell whose family has to be copied
    
    destination - the destination bytebuffer to which the family has to be copied
    
    destinationOffset - the offset in the destination bytebuffer
    
    Returns:
    
    the offset of the bytebuffer after the copy has happened
  - copyQualifierTo
```
public static int copyQualifierTo(Cell cell,
                                  byte[] destination,
                                  int destinationOffset)
```
    Copies the qualifier to the given byte[]
    
    Parameters:
    
    cell - the cell whose qualifier has to be copied
    
    destination - the destination byte[] to which the qualifier has to be copied
    
    destinationOffset - the offset in the destination byte[]
    
    Returns:
    
    the offset of the byte[] after the copy has happened
  - copyQualifierTo
```
public static int copyQualifierTo(Cell cell,
                                  ByteBuffer destination,
                                  int destinationOffset)
```
    Copies the qualifier to the given bytebuffer
    
    Parameters:
    
    cell - the cell whose qualifier has to be copied
    
    destination - the destination bytebuffer to which the qualifier has to be copied
    
    destinationOffset - the offset in the destination bytebuffer
    
    Returns:
    
    the offset of the bytebuffer after the copy has happened
  - copyValueTo
```
public static int copyValueTo(Cell cell,
                              byte[] destination,
                              int destinationOffset)
```
    Copies the value to the given byte[]
    
    Parameters:
    
    cell - the cell whose value has to be copied
    
    destination - the destination byte[] to which the value has to be copied
    
    destinationOffset - the offset in the destination byte[]
    
    Returns:
    
    the offset of the byte[] after the copy has happened
  - copyValueTo
```
public static int copyValueTo(Cell cell,
                              ByteBuffer destination,
                              int destinationOffset)
```
    Copies the value to the given bytebuffer
    
    Parameters:
    
    cell - the cell whose value has to be copied
    
    destination - the destination bytebuffer to which the value has to be copied
    
    destinationOffset - the offset in the destination bytebuffer
    
    Returns:
    
    the offset of the bytebuffer after the copy has happened
  - copyTagTo
```
@Deprecated
public static int copyTagTo(Cell cell,
                                        byte[] destination,
                                        int destinationOffset)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0.
    
    Copies the tags info into the tag portion of the cell
    
    Parameters:
    
    cell -
    
    destination -
    
    destinationOffset -
    
    Returns:
    
    position after tags
  - copyTagTo
```
@Deprecated
public static int copyTagTo(Cell cell,
                                        ByteBuffer destination,
                                        int destinationOffset)
```
    Deprecated. As of HBase-2.0. Will be removed in 3.0.
    
    Copies the tags info into the tag portion of the cell
    
    Parameters:
    
    cell -
    
    destination -
    
    destinationOffset -
    
    Returns:
    
    position after tags
  - getRowByte
```
@InterfaceAudience.Private
 @Deprecated
public static byte getRowByte(Cell cell,
                                                                      int index)
```
    Deprecated.
    
    misc
  - getValueBufferShallowCopy
```
@Deprecated
public static ByteBuffer getValueBufferShallowCopy(Cell cell)
```
    Deprecated. As of HBase-2.0. Will be removed in 3.0.
  - getQualifierBufferShallowCopy
```
@Deprecated
public static ByteBuffer getQualifierBufferShallowCopy(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Parameters:
    
    cell -
    
    Returns:
    
    cell's qualifier wrapped into a ByteBuffer.
  - createCell
```
@Deprecated
public static Cell createCell(byte[] row,
                                          byte[] family,
                                          byte[] qualifier,
                                          long timestamp,
                                          byte type,
                                          byte[] value)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use CellBuilder instead
  - createCell
```
@Deprecated
public static Cell createCell(byte[] rowArray,
                                          int rowOffset,
                                          int rowLength,
                                          byte[] familyArray,
                                          int familyOffset,
                                          int familyLength,
                                          byte[] qualifierArray,
                                          int qualifierOffset,
                                          int qualifierLength)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use CellBuilder instead
    
    Creates a cell with deep copy of all passed bytes.
  - createCell
```
@InterfaceAudience.Private
 @Deprecated
public static Cell createCell(byte[] row,
                                                                      byte[] family,
                                                                      byte[] qualifier,
                                                                      long timestamp,
                                                                      byte type,
                                                                      byte[] value,
                                                                      long memstoreTS)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use ExtendedCellBuilder instead
    
    Marked as audience Private as of 1.2.0. Creating a Cell with a memstoreTS/mvcc is an internal implementation detail not for public use.
  - createCell
```
@InterfaceAudience.Private
 @Deprecated
public static Cell createCell(byte[] row,
                                                                      byte[] family,
                                                                      byte[] qualifier,
                                                                      long timestamp,
                                                                      byte type,
                                                                      byte[] value,
                                                                      byte[] tags,
                                                                      long memstoreTS)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use ExtendedCellBuilder instead
    
    Marked as audience Private as of 1.2.0. Creating a Cell with tags and a memstoreTS/mvcc is an internal implementation detail not for public use.
  - createCell
```
@InterfaceAudience.Private
 @Deprecated
public static Cell createCell(byte[] row,
                                                                      byte[] family,
                                                                      byte[] qualifier,
                                                                      long timestamp,
                                                                      KeyValue.Type type,
                                                                      byte[] value,
                                                                      byte[] tags)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use ExtendedCellBuilder instead
    
    Marked as audience Private as of 1.2.0. Creating a Cell with tags is an internal implementation detail not for public use.
  - createCell
```
@Deprecated
public static Cell createCell(byte[] row)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use CellBuilder instead
    
    Create a Cell with specific row. Other fields defaulted.
    
    Parameters:
    
    row -
    
    Returns:
    
    Cell with passed row but all other fields are arbitrary
  - createCell
```
@Deprecated
public static Cell createCell(byte[] row,
                                          byte[] value)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use CellBuilder instead
    
    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
```
@Deprecated
public static Cell createCell(byte[] row,
                                          byte[] family,
                                          byte[] qualifier)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use CellBuilder instead
    
    Create a Cell with specific row. Other fields defaulted.
    
    Parameters:
    
    row -
    
    family -
    
    qualifier -
    
    Returns:
    
    Cell with passed row but all other fields are arbitrary
  - createCell
```
@Deprecated
public static Cell createCell(Cell cell,
                                          List<Tag> tags)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Note : Now only CPs can create cell with tags using the CP environment
    
    Returns:
    
    A new cell which is having the extra tags also added to it.
  - createCell
```
@Deprecated
public static Cell createCell(Cell cell,
                                          byte[] tags)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Now only CPs can create cell with tags using the CP environment
    
    Returns:
    
    A new cell which is having the extra tags also added to it.
  - createCell
```
@Deprecated
public static Cell createCell(Cell cell,
                                          byte[] value,
                                          byte[] tags)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Now only CPs can create cell with tags using the CP environment
  - createCellScanner
```
public static CellScanner createCellScanner(List<? extends CellScannable> cellScannerables)
```
    Parameters:
    
    cellScannerables -
    
    Returns:
    
    CellScanner interface over cellIterables
  - createCellScanner
```
public static CellScanner createCellScanner(Iterable<Cell> cellIterable)
```
    Parameters:
    
    cellIterable -
    
    Returns:
    
    CellScanner interface over cellIterable
  - createCellScanner
```
public static CellScanner createCellScanner(Iterator<Cell> cells)
```
    Parameters:
    
    cells -
    
    Returns:
    
    CellScanner interface over cellIterable or null if cells is null
  - createCellScanner
```
public static CellScanner createCellScanner(Cell[] cellArray)
```
    Parameters:
    
    cellArray -
    
    Returns:
    
    CellScanner interface over cellArray
  - createCellScanner
```
public static 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
```
@Deprecated
public static boolean matchingRow(Cell left,
                                              Cell right)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use matchingRows(Cell, Cell)
    
    Parameters:
    
    left -
    
    right -
    
    Returns:
    
    True if the rows in left and right Cells match
  - matchingRow
```
@Deprecated
public static boolean matchingRow(Cell left,
                                              byte[] buf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use #matchingRows(Cell, byte[]))
  - matchingRows
```
public static boolean matchingRows(Cell left,
                                   byte[] buf)
```
  - matchingRow
```
@Deprecated
public static boolean matchingRow(Cell left,
                                              byte[] buf,
                                              int offset,
                                              int length)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Instead use matchingRows(Cell, Cell)
    
    Returns:
    
    true if the row is matching
  - matchingFamily
```
public static boolean matchingFamily(Cell left,
                                     Cell right)
```
  - matchingFamily
```
public static boolean matchingFamily(Cell left,
                                     byte[] buf)
```
  - matchingFamily
```
@Deprecated
public static boolean matchingFamily(Cell left,
                                                 byte[] buf,
                                                 int offset,
                                                 int length)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - matchingQualifier
```
public static boolean matchingQualifier(Cell left,
                                        Cell right)
```
  - matchingQualifier
```
public static boolean matchingQualifier(Cell left,
                                        byte[] buf)
```
    Finds if the qualifier part of the cell and the KV serialized byte[] are equal
    
    Parameters:
    
    left -
    
    buf - the serialized keyvalue format byte[]
    
    Returns:
    
    true if the qualifier matches, false otherwise
  - matchingQualifier
```
@Deprecated
public static boolean matchingQualifier(Cell left,
                                                    byte[] buf,
                                                    int offset,
                                                    int length)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Finds if the qualifier part of the cell and the KV serialized byte[] are equal
    
    Parameters:
    
    left -
    
    buf - the serialized keyvalue format byte[]
    
    offset - the offset of the qualifier in the byte[]
    
    length - the length of the qualifier in the byte[]
    
    Returns:
    
    true if the qualifier matches, false otherwise
  - matchingColumn
```
public static boolean matchingColumn(Cell left,
                                     byte[] fam,
                                     byte[] qual)
```
  - matchingColumn
```
@Deprecated
public static boolean matchingColumn(Cell left,
                                                 byte[] fam,
                                                 int foffset,
                                                 int flength,
                                                 byte[] qual,
                                                 int qoffset,
                                                 int qlength)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - 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)
```
  - 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
```
@Deprecated
public static boolean isDelete(byte type)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Returns:
    
    True if a delete type, a KeyValue.Type.Delete or a {KeyValue.Type#DeleteFamily} or a KeyValue.Type.DeleteColumn KeyValue type.
  - isDeleteType
```
@Deprecated
public static boolean isDeleteType(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Returns:
    
    True if this cell is a KeyValue.Type.Delete type.
  - isDeleteFamily
```
@Deprecated
public static boolean isDeleteFamily(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - isDeleteFamilyVersion
```
@Deprecated
public static boolean isDeleteFamilyVersion(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - isDeleteColumns
```
@Deprecated
public static boolean isDeleteColumns(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - isDeleteColumnVersion
```
@Deprecated
public static boolean isDeleteColumnVersion(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
  - isDeleteColumnOrFamily
```
@Deprecated
public static boolean isDeleteColumnOrFamily(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Returns:
    
    True if this cell is a delete family or column type.
  - isPut
```
public static boolean isPut(Cell cell)
```
    Returns:
    
    True if this cell is a Put.
  - estimatedSerializedSizeOf
```
@Deprecated
public static int estimatedSerializedSizeOf(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    Estimate based on keyvalue's serialization format in the RPC layer. Note that there is an extra SIZEOF_INT added to the size here that indicates the actual length of the cell for cases where cell's are serialized in a contiguous format (For eg in RPCs).
    
    Parameters:
    
    cell -
    
    Returns:
    
    Estimate of the cell size in bytes plus an extra SIZEOF_INT indicating the actual cell length.
  - getSumOfCellElementLengths
```
private static int getSumOfCellElementLengths(Cell cell)
```
    Parameters:
    
    cell -
    
    Returns:
    
    Sum of the lengths of all the elements in a Cell; does not count in any infrastructure
  - getSumOfCellKeyElementLengths
```
private static int getSumOfCellKeyElementLengths(Cell cell)
```
    Parameters:
    
    cell -
    
    Returns:
    
    Sum of all elements that make up a key; does not include infrastructure, tags or values.
  - estimatedSerializedSizeOfKey
```
@Deprecated
public static int estimatedSerializedSizeOfKey(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
    
    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
```
@Deprecated
public static long estimatedHeapSizeOf(Cell cell)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use RawCell.getTags()
    
    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 bytes occupied by the cell components ie. row, CF, qualifier, timestamp, type, value and tags.
    
    Parameters:
    
    cell -
    
    Returns:
    
    estimate of the heap space
  - tagsIterator
```
@Deprecated
public static Iterator<Tag> tagsIterator(byte[] tags,
                                                     int offset,
                                                     int length)
```
    Deprecated. As of 2.0.0 and will be removed in 3.0.0 Instead use PrivateCellUtil.tagsIterator(Cell)
    
    Util method to iterate through the tags
    
    Parameters:
    
    tags -
    
    offset -
    
    length -
    
    Returns:
    
    iterator for the tags
  - getTags
```
@Deprecated
public static List<Tag> getTags(Cell cell)
```
    Deprecated. As of 2.0.0 and will be removed in 3.0.0
    
    Parameters:
    
    cell - The Cell
    
    Returns:
    
    Tags in the given Cell as a List
  - getTag
```
@Deprecated
public static Tag getTag(Cell cell,
                                     byte type)
```
    Deprecated. As of 2.0.0 and will be removed in HBase-3.0.0 Use RawCell.getTag(byte)
    
    Retrieve Cell's first tag, matching the passed in type
    
    Parameters:
    
    cell - The Cell
    
    type - Type of the Tag to retrieve
    
    Returns:
    
    null if there is no tag of the passed in tag type
  - overlappingKeys
```
@Deprecated
public static boolean overlappingKeys(byte[] start1,
                                                  byte[] end1,
                                                  byte[] start2,
                                                  byte[] end2)
```
    Deprecated. As of 2.0.0 and will be removed in 3.0.0
    
    Returns true if the first range start1...end1 overlaps with the second range start2...end2, assuming the byte arrays represent row keys
  - setSequenceId
```
@Deprecated
public static void setSequenceId(Cell cell,
                                             long seqId)
                                      throws IOException
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    Sets the given seqId to the cell. Marked as audience Private as of 1.2.0. Setting a Cell sequenceid is an internal implementation detail not for general public use.
    
    Parameters:
    
    cell -
    
    seqId -
    
    Throws:
    
    IOException - when the passed cell is not of type ExtendedCell
  - setTimestamp
```
@Deprecated
public static void setTimestamp(Cell cell,
                                            long ts)
                                     throws IOException
```
    Deprecated. As of HBase-2.0. Will be a LimitedPrivate API in HBase-3.0.
    
    Sets the given timestamp to the cell.
    
    Parameters:
    
    cell -
    
    ts -
    
    Throws:
    
    IOException - when the passed cell is not of type ExtendedCell
  - setTimestamp
```
@Deprecated
public static void setTimestamp(Cell cell,
                                            byte[] ts,
                                            int tsOffset)
                                     throws IOException
```
    Deprecated. As of HBase-2.0. Will be a LimitedPrivate API in HBase-3.0.
    
    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 ExtendedCell
  - updateLatestStamp
```
@Deprecated
public static boolean updateLatestStamp(Cell cell,
                                                    long ts)
                                             throws IOException
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    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 ExtendedCell
  - updateLatestStamp
```
@Deprecated
public static boolean updateLatestStamp(Cell cell,
                                                    byte[] ts,
                                                    int tsOffset)
                                             throws IOException
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    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 ExtendedCell
  - writeFlatKey
```
@Deprecated
public static void writeFlatKey(Cell cell,
                                            DataOutputStream out)
                                     throws IOException
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    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
  - writeRowSkippingBytes
```
@Deprecated
public static void writeRowSkippingBytes(DataOutputStream out,
                                                     Cell cell,
                                                     short rlength,
                                                     int commonPrefix)
                                              throws IOException
```
    Deprecated. As of 2.0. Will be removed in hbase-3.0
    
    Writes the row from the given cell to the output stream excluding the common prefix
    
    Parameters:
    
    out - The dataoutputstream to which the data has to be written
    
    cell - The cell whose contents has to be written
    
    rlength - the row length
    
    Throws:
    
    IOException
  - getCellKeyAsString
```
public static String getCellKeyAsString(Cell cell)
```
    Parameters:
    
    cell -
    
    Returns:
    
    The Key portion of the passed cell as a String.
  - getCellKeySerializedAsKeyValueKey
```
@Deprecated
public static byte[] getCellKeySerializedAsKeyValueKey(Cell cell)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    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
```
@Deprecated
public static void writeRowKeyExcludingCommon(Cell cell,
                                                          short rLen,
                                                          int commonPrefix,
                                                          DataOutputStream out)
                                                   throws IOException
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    Write rowkey excluding the common part.
    
    Parameters:
    
    cell -
    
    rLen -
    
    commonPrefix -
    
    out -
    
    Throws:
    
    IOException
  - findCommonPrefixInFlatKey
```
@Deprecated
public static int findCommonPrefixInFlatKey(Cell c1,
                                                        Cell c2,
                                                        boolean bypassFamilyCheck,
                                                        boolean withTsType)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    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
  - equalsIgnoreMvccVersion
```
@Deprecated
public static boolean equalsIgnoreMvccVersion(Cell a,
                                                          Cell b)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    special case for Cell.equals
  - equals
```
public static boolean equals(Cell a,
                             Cell b)
```
    equals
  - matchingTimestamp
```
public static boolean matchingTimestamp(Cell a,
                                        Cell b)
```
  - matchingType
```
@Deprecated
public static boolean matchingType(Cell a,
                                               Cell b)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
  - matchingRows
```
public static boolean matchingRows(Cell left,
                                   Cell right)
```
    Compares the row of two keyvalues for equality
    
    Parameters:
    
    left -
    
    right -
    
    Returns:
    
    True if rows match.
  - 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.
  - matchingRowColumnBytes
```
public static boolean matchingRowColumnBytes(Cell left,
                                             Cell right)
```
  - compareQualifiers
```
public static final int compareQualifiers(Cell left,
                                          byte[] right,
                                          int rOffset,
                                          int rLength)
```
    Compares the cell's qualifier with the given byte[]
    
    Parameters:
    
    left - the cell for which the qualifier has to be compared
    
    right - the byte[] having the qualifier
    
    rOffset - the offset of the qualifier
    
    rLength - the length of the qualifier
    
    Returns:
    
    greater than 0 if left cell's qualifier is bigger than byte[], lesser than 0 if left cell's qualifier is lesser than byte[] and 0 otherwise
  - compare
```
@Deprecated
public static final int compare(CellComparator comparator,
                                            Cell left,
                                            byte[] key,
                                            int offset,
                                            int length)
```
    Deprecated. As of HBase-2.0. Will be removed in HBase-3.0
    
    Used when a cell needs to be compared with a key byte[] such as cases of finding the index from the index block, bloom keys from the bloom blocks This byte[] is expected to be serialized in the KeyValue serialization format If the KeyValue (Cell's) serialization format changes this method cannot be used.
    
    Parameters:
    
    comparator - the cell comparator
    
    left - the cell to be compared
    
    key - the serialized key part of a KeyValue
    
    offset - the offset in the key byte[]
    
    length - the length of the key byte[]
    
    Returns:
    
    an int greater than 0 if left is greater than right lesser than 0 if left is lesser than right equal to 0 if left is equal to right
  - compareFamilies
```
public static final int compareFamilies(Cell left,
                                        byte[] right,
                                        int roffset,
                                        int rlength)
```
    Compares the cell's family with the given byte[]
    
    Parameters:
    
    left - the cell for which the family has to be compared
    
    right - the byte[] having the family
    
    roffset - the offset of the family
    
    rlength - the length of the family
    
    Returns:
    
    greater than 0 if left cell's family is bigger than byte[], lesser than 0 if left cell's family is lesser than byte[] and 0 otherwise
  - compareColumns
```
public static final int compareColumns(Cell left,
                                       byte[] right,
                                       int rfoffset,
                                       int rflength,
                                       int rqoffset,
                                       int rqlength)
```
    Compares the cell's column (family and qualifier) with the given byte[]
    
    Parameters:
    
    left - the cell for which the column has to be compared
    
    right - the byte[] having the column
    
    rfoffset - the offset of the family
    
    rflength - the length of the family
    
    rqoffset - the offset of the qualifier
    
    rqlength - the length of the qualifier
    
    Returns:
    
    greater than 0 if left cell's column is bigger than byte[], lesser than 0 if left cell's column is lesser than byte[] and 0 otherwise

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

cloneTags

getTagArray

makeColumn

parseColumn

copyRowTo

copyRowTo

copyRow

copyFamilyTo

copyFamilyTo

copyQualifierTo

copyQualifierTo

copyValueTo

copyValueTo

copyTagTo

copyTagTo

getRowByte

getValueBufferShallowCopy

getQualifierBufferShallowCopy

createCell

createCell

createCell

createCell

createCell

createCell

createCell

createCell

createCell

createCell

createCell

createCellScanner

createCellScanner

createCellScanner

createCellScanner

createCellScanner

matchingRow

matchingRow

matchingRows

matchingRow

matchingFamily

matchingFamily

matchingFamily

matchingQualifier

matchingQualifier

matchingQualifier

matchingColumn

matchingColumn

matchingColumn

matchingValue

matchingValue

isDelete

isDelete

isDeleteType

isDeleteFamily

isDeleteFamilyVersion

isDeleteColumns

isDeleteColumnVersion

isDeleteColumnOrFamily

isPut

estimatedSerializedSizeOf

getSumOfCellElementLengths

getSumOfCellKeyElementLengths

estimatedSerializedSizeOfKey

estimatedHeapSizeOf

tagsIterator