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[]>

@InterfaceAudience.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 and Description
static class	BitComparator.BitwiseOp Bit operators.

Field Summary

Fields

Modifier and Type	Field and Description
protected BitComparator.BitwiseOp	bitOperator

Constructor Summary

Constructors

Constructor and Description
BitComparator(byte[] value, BitComparator.BitwiseOp bitOperator) 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.
BitComparator.BitwiseOp	getOperator()
static BitComparator	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

Field Detail

bitOperator

protected BitComparator.BitwiseOp bitOperator

Constructor Detail

BitComparator

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

Constructor

Parameters:

value - value

bitOperator - operator to use on the bit comparison

Method Detail

getOperator

public BitComparator.BitwiseOp getOperator()

Returns:

the bitwise operator

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in class ByteArrayComparable

Returns:

The comparator serialized using pb

parseFrom

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

Parameters:

pbBytes - A pb serialized BitComparator instance

Returns:

An instance of BitComparator made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

See Also:

toByteArray()

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.