Package org.apache.hadoop.hbase.filter

Class BinaryComparator

java.lang.Object

org.apache.hadoop.hbase.filter.ByteArrayComparable

org.apache.hadoop.hbase.filter.BinaryComparator

All Implemented Interfaces:

Comparable<byte[]>

@Public
public class BinaryComparator
extends ByteArrayComparable

A binary comparator which lexicographically compares against the specified byte array using Bytes.compareTo(byte[], byte[]).

Since:

2.0.0

Field Summary

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

value

Constructor Summary

Constructors

Constructor	Description
BinaryComparator(byte[] value)	Constructor

Method Summary

Modifier and Type	Method	Description
(package private) boolean	areSerializedFieldsEqual(ByteArrayComparable other)	Returns true if and only if the fields of the comparator that are serialized are equal to the corresponding fields in 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 BinaryComparator	parseFrom(byte[] pbBytes)	Parse a serialized representation of BinaryComparator
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 Details

BinaryComparator

public BinaryComparator(byte[] value)

Constructor

Parameters:

value - value

Method Details

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 BinaryComparator parseFrom(byte[] pbBytes)
                                  throws DeserializationException

Parse a serialized representation of BinaryComparator

Parameters:

pbBytes - A pb serialized BinaryComparator instance

Returns:

An instance of BinaryComparator made from bytes

Throws:

DeserializationException - if an error occurred

See Also:

• toByteArray()

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(ByteArrayComparable 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.

Overrides:

areSerializedFieldsEqual in class ByteArrayComparable