org.apache.hadoop.hbase.filter

Class BinaryPrefixComparator

java.lang.Object

org.apache.hadoop.hbase.filter.ByteArrayComparable

org.apache.hadoop.hbase.filter.BinaryPrefixComparator

All Implemented Interfaces:

Comparable<byte[]>

@InterfaceAudience.Public
public class BinaryPrefixComparator
extends ByteArrayComparable

A comparator which compares against a specified byte array, but only compares up to the length of this byte array. For the rest it is similar to BinaryComparator.

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.ByteArrayComparable

value

Constructor Summary

Constructors

Constructor and Description
BinaryPrefixComparator(byte[] value) Constructor

Method Summary

Modifier and Type	Method and Description
(package private) boolean	areSerializedFieldsEqual(ByteArrayComparable other)
int	compareTo(byte[] value, int offset, int length) Special compareTo method for subclasses, to avoid copying byte[] unnecessarily.
int	compareTo(ByteBuffer value, int offset, int length) Special compareTo method for subclasses, to avoid copying bytes unnecessarily.
static BinaryPrefixComparator	parseFrom(byte[] pbBytes)
byte[]	toByteArray()

Methods inherited from class org.apache.hadoop.hbase.filter.ByteArrayComparable

compareTo, getValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryPrefixComparator

public BinaryPrefixComparator(byte[] value)

Constructor

Parameters:

value - value

Method Detail

compareTo

public int compareTo(byte[] value,
                     int offset,
                     int length)

Description copied from class: ByteArrayComparable

Special compareTo method for subclasses, to avoid copying byte[] unnecessarily.

Specified by:

compareTo in class ByteArrayComparable

Parameters:

value - byte[] to compare

offset - offset into value

length - number of bytes to compare

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareTo

public int compareTo(ByteBuffer value,
                     int offset,
                     int length)

Description copied from class: ByteArrayComparable

Special compareTo method for subclasses, to avoid copying bytes unnecessarily.

Overrides:

compareTo in class ByteArrayComparable

Parameters:

value - bytes to compare within a ByteBuffer

offset - offset into value

length - number of bytes to compare

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in class ByteArrayComparable

Returns:

The comparator serialized using pb

parseFrom

public static BinaryPrefixComparator parseFrom(byte[] pbBytes)
                                        throws DeserializationException

Parameters:

pbBytes - A pb serialized BinaryPrefixComparator instance

Returns:

An instance of BinaryPrefixComparator made from bytes

Throws:

DeserializationException

See Also:

toByteArray()

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(ByteArrayComparable other)

Overrides:

areSerializedFieldsEqual in class ByteArrayComparable

Parameters:

other -

Returns:

true if and only if the fields of the comparator that are serialized are equal to the corresponding fields in other. Used for testing.