CellUtil (Apache HBase 2.0.0-SNAPSHOT API)

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

-
-
-
```
@InterfaceAudience.Public
-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.
-

- -

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)`
`static byte[]`	`cloneValue(Cell cell)`
`static Cell`	`copyCellTo(Cell cell, - ByteBuffer buf, - int offset, - int len)` - Clone the passed cell by copying its data into the passed buf. -
`static int`	`copyFamilyTo(Cell cell, - byte[] destination, - int destinationOffset)`
`static int`	`copyFamilyTo(Cell cell, - ByteBuffer destination, - int destinationOffset)`
`static int`	`copyQualifierTo(Cell cell, - byte[] destination, - int destinationOffset)`
`static int`	`copyQualifierTo(Cell cell, - ByteBuffer destination, - int destinationOffset)`
`static byte[]`	`copyRow(Cell cell)` - Copies the row to a new byte[] -
`static int`	`copyRowTo(Cell cell, - byte[] destination, - int destinationOffset)` - copyTo -
`static int`	`copyRowTo(Cell cell, - ByteBuffer destination, - int destinationOffset)`
`static int`	`copyTagTo(Cell cell, - byte[] destination, - int destinationOffset)` - Copies the tags info into the tag portion of the cell -
`static int`	`copyTagTo(Cell cell, - ByteBuffer destination, - int destinationOffset)`
`static int`	`copyValueTo(Cell cell, - byte[] destination, - int destinationOffset)`
`static int`	`copyValueTo(Cell cell, - ByteBuffer 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 Cell`	`createCell(Cell cell, - byte[] tags)`
`static Cell`	`createCell(Cell cell, - byte[] value, - byte[] tags)`
`static Cell`	`createCell(Cell cell, - List<org.apache.hadoop.hbase.Tag> tags)`
`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 Cell`	`createFirstDeleteFamilyCellOnRow(byte[] row, - byte[] fam)` - Create a Delete Family Cell for the specified row and family that would - be smaller than all other possible Delete Family KeyValues that have the - same row and family. -
`static Cell`	`createFirstOnNextRow(Cell cell)` - Create a Cell that is smaller than all other possible Cells for the given Cell row's next row. -
`static Cell`	`createFirstOnRow(byte[] row)`
`static Cell`	`createFirstOnRow(byte[] row, - byte[] family, - byte[] col)`
`static Cell`	`createFirstOnRow(byte[] row, - int roffset, - short rlength)`
`static Cell`	`createFirstOnRow(byte[] row, - int roffset, - short rlength, - byte[] family, - int foffset, - byte flength, - byte[] col, - int coffset, - int clength)`
`static Cell`	`createFirstOnRow(Cell cell)` - Create a Cell that is smaller than all other possible Cells for the given Cell's row. -
`static Cell`	`createFirstOnRowCol(Cell cell)` - Create a Cell that is smaller than all other possible Cells for the given Cell's row. -
`static Cell`	`createFirstOnRowCol(Cell cell, - byte[] qArray, - int qoffest, - int qlength)` - Create a Cell that is smaller than all other possible Cells for the given Cell's rk:cf and - passed qualifier. -
`static Cell`	`createFirstOnRowColTS(Cell cell, - long ts)` - Creates the first cell with the row/family/qualifier of this cell and the given timestamp. -
`static Cell`	`createFirstOnRowFamily(Cell cell, - byte[] fArray, - int foff, - int flen)`
`static Cell`	`createLastOnRow(byte[] row)`
`static Cell`	`createLastOnRow(Cell cell)` - Create a Cell that is larger than all other possible Cells for the given Cell's row. -
`static Cell`	`createLastOnRowCol(Cell cell)` - Create a Cell that is larger than all other possible Cells for the given Cell's rk:cf:q. -
`static boolean`	`equals(Cell a, - Cell b)` - equals -
`static boolean`	`equalsIgnoreMvccVersion(Cell a, - Cell b)` - special case for Cell.equals -
`static long`	`estimatedHeapSizeOf(Cell cell)` - This is an estimate of the heap space occupied by a cell. -
`static int`	`estimatedSerializedSizeOf(Cell cell)` - Estimate based on keyvalue's serialization format. -
`static int`	`estimatedSerializedSizeOfKey(Cell cell)` - Calculates the serialized key size. -
`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)` - Deprecated. - As of release 2.0.0, this will be removed in HBase 3.0.0. - -
`static int`	`getRowAsInt(Cell cell)` - Converts the rowkey bytes of the given cell into an int value -
`static org.apache.hadoop.hbase.Tag`	`getTag(Cell cell, - byte type)` - Retrieve Cell's first tag, matching the passed in type -
`static byte[]`	`getTagArray(Cell cell)` - Returns tag value in a new byte array. -
`static List<org.apache.hadoop.hbase.Tag>`	`getTags(Cell cell)`
`static BigDecimal`	`getValueAsBigDecimal(Cell cell)` - Converts the value bytes of the given cell into a BigDecimal -
`static double`	`getValueAsDouble(Cell cell)` - Converts the value bytes of the given cell into a double value -
`static int`	`getValueAsInt(Cell cell)` - Converts the value bytes of the given cell into a int value -
`static long`	`getValueAsLong(Cell cell)` - Converts the value bytes of the given cell into a long value -
`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)` - 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)` - Finds if the qualifier part of the cell and the KV serialized - byte[] are equal -
`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)` - 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`	`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)`
`static boolean`	`matchingValue(Cell left, - byte[] buf)`
`static boolean`	`matchingValue(Cell left, - Cell right)`
`static boolean`	`matchingValue(Cell left, - Cell right, - int lvlength, - int rvlength)`
`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)` - Deprecated. - As of 2.0.0 and will be removed in 3.0.0 - Instead use `tagsIterator(Cell)` - -
`static Iterator<org.apache.hadoop.hbase.Tag>`	`tagsIterator(Cell cell)` - Util method to iterate through the tags in the given cell. -
`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`	`writeFamily(OutputStream out, - Cell cell, - byte flength)` - Writes the family from the given cell to the output stream -
`static void`	`writeFlatKey(Cell cell, - DataOutputStream out)` - Writes the Cell's key part as it would have serialized in a KeyValue. -
`static int`	`writeFlatKey(Cell cell, - OutputStream out)`
`static void`	`writeQualifier(OutputStream out, - Cell cell, - int qlength)` - Writes the qualifier from the given cell to the output stream -
`static void`	`writeQualifierSkippingBytes(DataOutputStream out, - Cell cell, - int qlength, - int commonPrefix)` - Writes the qualifier from the given cell to the output stream excluding the common prefix -
`static void`	`writeRow(OutputStream out, - Cell cell, - short rlength)` - Writes the row from the given cell to the output stream -
`static void`	`writeRowKeyExcludingCommon(Cell cell, - short rLen, - int commonPrefix, - DataOutputStream out)` - Write rowkey excluding the common part. -
`static void`	`writeRowSkippingBytes(DataOutputStream out, - Cell cell, - short rlength, - int commonPrefix)` - Writes the row from the given cell to the output stream excluding the common prefix -
`static void`	`writeTags(OutputStream out, - Cell cell, - int tagsLength)` - Writes the tag from the given cell to the output stream -
`static void`	`writeValue(OutputStream out, - Cell cell, - int vlength)` - Writes the value from the given cell to the output stream -

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

- -

- - -

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)

- - - -

cloneTags

public static byte[] cloneTags(Cell cell)

- - - -

-
getTagArray
-
```
public static byte[] getTagArray(Cell cell)
```
-
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.
-
-

- - - -

copyRowTo

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

copyTo

- - - -

copyRowTo

public static int copyRowTo(Cell cell,
-                            ByteBuffer destination,
-                            int destinationOffset)

- - - -

-
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)

- - - -

copyFamilyTo

public static int copyFamilyTo(Cell cell,
-                               ByteBuffer destination,
-                               int destinationOffset)

- - - -

copyQualifierTo

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

- - - -

copyQualifierTo

public static int copyQualifierTo(Cell cell,
-                                  ByteBuffer destination,
-                                  int destinationOffset)

- - - -

copyValueTo

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

- - - -

copyValueTo

public static int copyValueTo(Cell cell,
-                              ByteBuffer 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

- - - -

-
copyTagTo
-
```
public static int 
```

Class CellUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fillRowRange

fillFamilyRange

fillQualifierRange

fillValueRange

fillTagRange

cloneRow

cloneFamily

cloneQualifier

cloneValue

cloneTags

getTagArray

copyRowTo

copyRowTo

copyRow

copyFamilyTo

copyFamilyTo

copyQualifierTo

copyQualifierTo

copyValueTo

copyValueTo

copyTagTo

copyTagTo