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.

Constructor Summary

Constructors

Constructor and Description
BinaryPrefixComparator(byte[] value) Constructor

Method Summary

Modifier and Type	Method and Description
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) Parse a serialized representation of BinaryPrefixComparator
byte[]	toByteArray() Returns The comparator serialized using pb

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

Returns The comparator serialized using pb

Specified by:

toByteArray in class ByteArrayComparable

parseFrom

public static BinaryPrefixComparator parseFrom(byte[] pbBytes)
                                        throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parse a serialized representation of BinaryPrefixComparator

Parameters:

pbBytes - A pb serialized BinaryPrefixComparator instance

Returns:

An instance of BinaryPrefixComparator made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException - if an error occurred

See Also:

toByteArray()