com.alibaba.hbase.util

类 OrderedBytes

java.lang.Object

com.alibaba.hbase.util.OrderedBytes

public class OrderedBytes
extends Object

Provide a set of functions to convert numeric values into/from binary-comparable form. For Boolean and String, please use HBase's Bytes instead. For example: Consider integer values 100 and -100, their binary forms are : 100 -> 0x0000 0064 -100 -> 0xFFFF FF9C Apparently -100 is 'greater than' 100 by directly comparing to -100 in binary(similar to memcmp() in C). In order to get it right we have to flip the signed bit in this scenario: 100 -> 0x0000 0064 -> 0x8000 0064 -100 -> 0xFFFF FF9C -> 0x7FFF FF9C By flipping the signed bit, negative values will be sorted before the positives. Note that this utility class has two parts: 1) Basic functions to handle ordered bytes conversion, this is enough for most of the cases. 2) Support user-defined sort order for each data type, there are 4 methods in each part, consider INT: 1) convert int to byte[] toBytes(int) putInt(byte[], int, int) 2) convert byte[] to int toInt(byte[]) toInt(byte[], int)

构造器概要

构造器

构造器和说明
OrderedBytes()

方法概要

限定符和类型	方法和说明
static int	putBigDecimal(byte[] output, int offset, BigDecimal val) Put a BigDecimal value into the specified byte array position, using its binary-comparable form.
static int	putBigDecimal(byte[] output, int offset, BigDecimal val, AliHBaseColumn.SortOrder order) Put a BigDecimal value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putByte(byte[] output, int offset, byte val) Put a byte value into the specified byte array position, using its binary-comparable form.
static int	putByte(byte[] output, int offset, byte val, AliHBaseColumn.SortOrder order) Put a byte value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putDouble(byte[] output, int offset, double val) Put a double value into the specified byte array position, using its binary-comparable form.
static int	putDouble(byte[] output, int offset, double val, AliHBaseColumn.SortOrder order) Put a double value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putFloat(byte[] output, int offset, float val) Put a float value into the specified byte array position, using its binary-comparable form.
static int	putFloat(byte[] output, int offset, float val, AliHBaseColumn.SortOrder order) Put a float value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putInt(byte[] output, int offset, int val) Put an integer value into the specified byte array position, using its binary-comparable form.
static int	putInt(byte[] output, int offset, int val, AliHBaseColumn.SortOrder order) Put an integer value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putLong(byte[] output, int offset, long val) Put a long value into the specified byte array position, using its binary-comparable form.
static int	putLong(byte[] output, int offset, long val, AliHBaseColumn.SortOrder order) Put a long value into the specified byte array position, using its binary-comparable form with explicit sort order.
static int	putShort(byte[] output, int offset, short val) Put a short value into the specified byte array position, using its binary-comparable form.
static int	putShort(byte[] output, int offset, short val, AliHBaseColumn.SortOrder order) Put a short value into the specified byte array position, using its binary-comparable form with explicit sort order.
static BigDecimal	toBigDecimal(byte[] bytes) Deserialize a BigDecimal value from its binary-comparable byte array.
static BigDecimal	toBigDecimal(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a BigDecimal value from its binary-comparable byte array with explicit sort order.
static BigDecimal	toBigDecimal(byte[] bytes, int offset, int length) Deserialize a BigDecimal value from its binary-comparable byte array.
static BigDecimal	toBigDecimal(byte[] bytes, int offset, int length, AliHBaseColumn.SortOrder order) Deserialize a BigDecimal value from its binary-comparable byte array with explicit sort order.
static byte	toByte(byte[] bytes) Deserialize a byte value from its binary-comparable byte array.
static byte	toByte(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a byte value from its binary-comparable byte array with explicit sort order.
static byte	toByte(byte[] bytes, int offset) Deserialize a byte value from its binary-comparable byte array.
static byte	toByte(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize a byte value from its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(BigDecimal val) Serialize a BigDecimal value into its binary-comparable byte array.
static byte[]	toBytes(BigDecimal val, AliHBaseColumn.SortOrder order) Serialize a BigDecimal value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(byte val) Serialize a byte value into its binary-comparable byte array.
static byte[]	toBytes(byte val, AliHBaseColumn.SortOrder order) Serialize a byte value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(double val) Serialize a double value into its binary-comparable byte array.
static byte[]	toBytes(double val, AliHBaseColumn.SortOrder order) Serialize a double value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(float val) Serialize a float value into its binary-comparable byte array.
static byte[]	toBytes(float val, AliHBaseColumn.SortOrder order) Serialize a float value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(int val) Serialize an integer value into its binary-comparable byte array.
static byte[]	toBytes(int val, AliHBaseColumn.SortOrder order) Serialize an integer value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(long val) Serialize a long value into its binary-comparable byte array.
static byte[]	toBytes(long val, AliHBaseColumn.SortOrder order) Serialize a long value into its binary-comparable byte array with explicit sort order.
static byte[]	toBytes(short val) Serialize a short value into its binary-comparable byte array.
static byte[]	toBytes(short val, AliHBaseColumn.SortOrder order) Serialize a short value into its binary-comparable byte array with explicit sort order.
static double	toDouble(byte[] bytes) Deserialize a double value from its binary-comparable byte array.
static double	toDouble(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a double value from its binary-comparable byte array with explicit sort order.
static double	toDouble(byte[] bytes, int offset) Deserialize a double value from its binary-comparable byte array.
static double	toDouble(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize a double value from its binary-comparable byte array with explicit sort order.
static float	toFloat(byte[] bytes) Deserialize a float value from its binary-comparable byte array.
static float	toFloat(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a float value from its binary-comparable byte array with explicit sort order.
static float	toFloat(byte[] bytes, int offset) Deserialize a float value from its binary-comparable byte array.
static float	toFloat(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize a float value from its binary-comparable byte array with explicit sort order.
static int	toInt(byte[] bytes) Deserialize an integer value from its binary-comparable byte array.
static int	toInt(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize an integer value from its binary-comparable byte array with explicit sort order.
static int	toInt(byte[] bytes, int offset) Deserialize an integer value from its binary-comparable byte array.
static int	toInt(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize an integer value from its binary-comparable byte array with explicit sort order.
static long	toLong(byte[] bytes) Deserialize a long value from its binary-comparable byte array.
static long	toLong(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a long value from its binary-comparable byte array with explicit sort order.
static long	toLong(byte[] bytes, int offset) Deserialize a long value from its binary-comparable byte array.
static long	toLong(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize a long value from its binary-comparable byte array with explicit sort order.
static short	toShort(byte[] bytes) Deserialize a short value from its binary-comparable byte array.
static short	toShort(byte[] bytes, AliHBaseColumn.SortOrder order) Deserialize a short value from its binary-comparable byte array with explicit sort order.
static short	toShort(byte[] bytes, int offset) Deserialize a short value from its binary-comparable byte array.
static short	toShort(byte[] bytes, int offset, AliHBaseColumn.SortOrder order) Deserialize a short value from its binary-comparable byte array with explicit sort order.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OrderedBytes

public OrderedBytes()

方法详细资料

toBytes

public static byte[] toBytes(byte val)

Serialize a byte value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putByte

public static int putByte(byte[] output,
                          int offset,
                          byte val)

Put a byte value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - byte value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toByte

public static byte toByte(byte[] bytes)

Deserialize a byte value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a byte value

返回:

deserialized value

toByte

public static byte toByte(byte[] bytes,
                          int offset)

Deserialize a byte value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a byte value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(short val)

Serialize a short value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putShort

public static int putShort(byte[] output,
                           int offset,
                           short val)

Put a short value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - short value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toShort

public static short toShort(byte[] bytes)

Deserialize a short value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a short value

返回:

deserialized value

toShort

public static short toShort(byte[] bytes,
                            int offset)

Deserialize a short value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a short value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(int val)

Serialize an integer value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putInt

public static int putInt(byte[] output,
                         int offset,
                         int val)

Put an integer value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - integer value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toInt

public static int toInt(byte[] bytes)

Deserialize an integer value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of an integer value

返回:

deserialized value

toInt

public static int toInt(byte[] bytes,
                        int offset)

Deserialize an integer value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of an integer value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(long val)

Serialize a long value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putLong

public static int putLong(byte[] output,
                          int offset,
                          long val)

Put a long value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - long value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toLong

public static long toLong(byte[] bytes)

Deserialize a long value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a long value

返回:

deserialized value

toLong

public static long toLong(byte[] bytes,
                          int offset)

Deserialize a long value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a long value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(float val)

Serialize a float value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putFloat

public static int putFloat(byte[] output,
                           int offset,
                           float val)

Put a float value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - float value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toFloat

public static float toFloat(byte[] bytes)

Deserialize a float value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a float value

返回:

deserialized value

toFloat

public static float toFloat(byte[] bytes,
                            int offset)

Deserialize a float value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a float value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(double val)

Serialize a double value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putDouble

public static int putDouble(byte[] output,
                            int offset,
                            double val)

Put a double value into the specified byte array position, using its binary-comparable form.

参数:

output - the output byte array

offset - position in the array

val - double value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toDouble

public static double toDouble(byte[] bytes)

Deserialize a double value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a double value

返回:

deserialized value

toDouble

public static double toDouble(byte[] bytes,
                              int offset)

Deserialize a double value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a double value

offset - start position

返回:

deserialized value

toBytes

public static byte[] toBytes(BigDecimal val)

Serialize a BigDecimal value into its binary-comparable byte array.

参数:

val - value to be serialized.

返回:

binary-comparable byte array of the specified value

putBigDecimal

public static int putBigDecimal(byte[] output,
                                int offset,
                                BigDecimal val)

Put a BigDecimal value into the specified byte array position, using its binary-comparable form. Note: BigDecimal has variable length in binary format, so it's difficult to estimate the actual size and create a proper byte array in advance. So this method is rarely used.

参数:

output - the output byte array

offset - position in the array

val - BigDecimal value to write to

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toBigDecimal

public static BigDecimal toBigDecimal(byte[] bytes)

Deserialize a BigDecimal value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a BigDecimal value

返回:

deserialized value

toBigDecimal

public static BigDecimal toBigDecimal(byte[] bytes,
                                      int offset,
                                      int length)

Deserialize a BigDecimal value from its binary-comparable byte array.

参数:

bytes - binary-comparable byte array of a BigDecimal value

offset - start position

length - number of bytes that represents this BigDecimal value

返回:

deserialized value

toBytes

public static byte[] toBytes(byte val,
                             AliHBaseColumn.SortOrder order)

Serialize a byte value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putByte

public static int putByte(byte[] output,
                          int offset,
                          byte val,
                          AliHBaseColumn.SortOrder order)

Put a byte value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - byte value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toByte

public static byte toByte(byte[] bytes,
                          AliHBaseColumn.SortOrder order)

Deserialize a byte value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a byte value

order - sort order of this value

返回:

deserialized value

toByte

public static byte toByte(byte[] bytes,
                          int offset,
                          AliHBaseColumn.SortOrder order)

Deserialize a byte value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a byte value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(short val,
                             AliHBaseColumn.SortOrder order)

Serialize a short value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putShort

public static int putShort(byte[] output,
                           int offset,
                           short val,
                           AliHBaseColumn.SortOrder order)

Put a short value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - short value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toShort

public static short toShort(byte[] bytes,
                            AliHBaseColumn.SortOrder order)

Deserialize a short value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a short value

order - sort order of this value

返回:

deserialized value

toShort

public static short toShort(byte[] bytes,
                            int offset,
                            AliHBaseColumn.SortOrder order)

Deserialize a short value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a short value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(int val,
                             AliHBaseColumn.SortOrder order)

Serialize an integer value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putInt

public static int putInt(byte[] output,
                         int offset,
                         int val,
                         AliHBaseColumn.SortOrder order)

Put an integer value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - integer value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toInt

public static int toInt(byte[] bytes,
                        AliHBaseColumn.SortOrder order)

Deserialize an integer value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of an integer value

order - sort order of this value

返回:

deserialized value

toInt

public static int toInt(byte[] bytes,
                        int offset,
                        AliHBaseColumn.SortOrder order)

Deserialize an integer value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of an integer value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(long val,
                             AliHBaseColumn.SortOrder order)

Serialize a long value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putLong

public static int putLong(byte[] output,
                          int offset,
                          long val,
                          AliHBaseColumn.SortOrder order)

Put a long value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - long value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toLong

public static long toLong(byte[] bytes,
                          AliHBaseColumn.SortOrder order)

Deserialize a long value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a long value

order - sort order of this value

返回:

deserialized value

toLong

public static long toLong(byte[] bytes,
                          int offset,
                          AliHBaseColumn.SortOrder order)

Deserialize a long value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a long value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(float val,
                             AliHBaseColumn.SortOrder order)

Serialize a float value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putFloat

public static int putFloat(byte[] output,
                           int offset,
                           float val,
                           AliHBaseColumn.SortOrder order)

Put a float value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - float value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toFloat

public static float toFloat(byte[] bytes,
                            AliHBaseColumn.SortOrder order)

Deserialize a float value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a float value

order - sort order of this value

返回:

deserialized value

toFloat

public static float toFloat(byte[] bytes,
                            int offset,
                            AliHBaseColumn.SortOrder order)

Deserialize a float value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a float value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(double val,
                             AliHBaseColumn.SortOrder order)

Serialize a double value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putDouble

public static int putDouble(byte[] output,
                            int offset,
                            double val,
                            AliHBaseColumn.SortOrder order)

Put a double value into the specified byte array position, using its binary-comparable form with explicit sort order.

参数:

output - the output byte array

offset - position in the array

val - double value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toDouble

public static double toDouble(byte[] bytes,
                              AliHBaseColumn.SortOrder order)

Deserialize a double value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a double value

order - sort order of this value

返回:

deserialized value

toDouble

public static double toDouble(byte[] bytes,
                              int offset,
                              AliHBaseColumn.SortOrder order)

Deserialize a double value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a double value

offset - start position

order - sort order of this value

返回:

deserialized value

toBytes

public static byte[] toBytes(BigDecimal val,
                             AliHBaseColumn.SortOrder order)

Serialize a BigDecimal value into its binary-comparable byte array with explicit sort order.

参数:

val - value to be serialized.

order - sort order of this value

返回:

binary-comparable byte array of the specified value

putBigDecimal

public static int putBigDecimal(byte[] output,
                                int offset,
                                BigDecimal val,
                                AliHBaseColumn.SortOrder order)

Put a BigDecimal value into the specified byte array position, using its binary-comparable form with explicit sort order. Note: BigDecimal has variable length in binary format, so it's difficult to estimate the actual size and create a proper byte array in advance. So this method is rarely used.

参数:

output - the output byte array

offset - position in the array

val - BigDecimal value to write to

order - sort order of this value

返回:

incremented offset

抛出:

IllegalArgumentException - if the specified byte array doesn't have enough room to hold this value

toBigDecimal

public static BigDecimal toBigDecimal(byte[] bytes,
                                      AliHBaseColumn.SortOrder order)

Deserialize a BigDecimal value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a BigDecimal value

order - sort order of this value

返回:

deserialized value

toBigDecimal

public static BigDecimal toBigDecimal(byte[] bytes,
                                      int offset,
                                      int length,
                                      AliHBaseColumn.SortOrder order)

Deserialize a BigDecimal value from its binary-comparable byte array with explicit sort order.

参数:

bytes - binary-comparable byte array of a BigDecimal value

offset - start position

length - number of bytes that represents this BigDecimal value

order - sort order of this value

返回:

deserialized value