Package org.apache.hadoop.hbase.filter

Class BitComparator

java.lang.Object

org.apache.hadoop.hbase.filter.ByteArrayComparable

org.apache.hadoop.hbase.filter.BitComparator

All Implemented Interfaces:

Comparable<byte[]>

@Public
public class BitComparator
extends ByteArrayComparable

A bit comparator which performs the specified bitwise operation on each of the bytes with the specified byte array. Then returns whether the result is non-zero.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BitComparator.BitwiseOp	Bit operators.

Field Summary

Fields

Modifier and Type	Field	Description
protected BitComparator.BitwiseOp	bitOperator

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

value

Constructor Summary

Constructors

Constructor	Description
BitComparator(byte[] value, BitComparator.BitwiseOp bitOperator)	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.
BitComparator.BitwiseOp	getOperator()	Returns the bitwise operator
static BitComparator	parseFrom(byte[] pbBytes)	Parse a serialized representation of BitComparator
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

Field Details

bitOperator

protected BitComparator.BitwiseOp bitOperator

Constructor Details

BitComparator

public BitComparator(byte[] value,
 BitComparator.BitwiseOp bitOperator)

Constructor

Parameters:

value - value

bitOperator - operator to use on the bit comparison

Method Details

getOperator

public BitComparator.BitwiseOp getOperator()

Returns the bitwise operator

toByteArray

public byte[] toByteArray()

Returns The comparator serialized using pb

Specified by:

toByteArray in class ByteArrayComparable

parseFrom

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

Parse a serialized representation of BitComparator

Parameters:

pbBytes - A pb serialized BitComparator instance

Returns:

An instance of BitComparator 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

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.