com.metamx.collections.bitmap

Class WrappedBitSetBitmap

java.lang.Object

com.metamx.collections.bitmap.WrappedImmutableBitSetBitmap

com.metamx.collections.bitmap.WrappedBitSetBitmap

All Implemented Interfaces:

ImmutableBitmap, MutableBitmap

public class WrappedBitSetBitmap
extends WrappedImmutableBitSetBitmap
implements MutableBitmap

WrappedBitSetBitmap implements MutableBitmap for java.util.BitSet

Field Summary

Fields inherited from class com.metamx.collections.bitmap.WrappedImmutableBitSetBitmap

bitmap

Constructor Summary

Constructors

Constructor and Description
WrappedBitSetBitmap()
WrappedBitSetBitmap(BitSet bitSet)
WrappedBitSetBitmap(ByteBuffer byteBuffer)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int entry) Add the specified integer to the bitmap.
void	and(MutableBitmap mutableBitmap) Compute the bitwise-and of this bitmap with another bitmap.
void	andNot(MutableBitmap mutableBitmap) Compute the bitwise-andNot of this bitmap with another bitmap.
void	clear() Empties the content of this bitmap.
protected BitSet	cloneBitSet()
int	getSizeInBytes() Return the size in bytes for the purpose of serialization to a ByteBuffer.
void	or(MutableBitmap mutableBitmap) Compute the bitwise-or of this bitmap with another bitmap.
void	remove(int entry) Remove the specified integer to the bitmap.
void	serialize(ByteBuffer buffer) Write out a serialized (Immutable) version of the bitmap to the ByteBuffer.
void	xor(MutableBitmap mutableBitmap) Compute the bitwise-xor of this bitmap with another bitmap.

Methods inherited from class com.metamx.collections.bitmap.WrappedImmutableBitSetBitmap

compareTo, difference, get, intersection, isEmpty, iterator, size, toBytes, union

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamx.collections.bitmap.ImmutableBitmap

compareTo, difference, get, intersection, isEmpty, iterator, size, toBytes, union

Constructor Detail

WrappedBitSetBitmap

public WrappedBitSetBitmap()

WrappedBitSetBitmap

public WrappedBitSetBitmap(BitSet bitSet)

WrappedBitSetBitmap

public WrappedBitSetBitmap(ByteBuffer byteBuffer)

Method Detail

cloneBitSet

protected BitSet cloneBitSet()

clear

public void clear()

Description copied from interface: MutableBitmap

Empties the content of this bitmap.

Specified by:

clear in interface MutableBitmap

or

public void or(MutableBitmap mutableBitmap)

Description copied from interface: MutableBitmap

Compute the bitwise-or of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Specified by:

or in interface MutableBitmap

Parameters:

mutableBitmap - other bitmap

and

public void and(MutableBitmap mutableBitmap)

Description copied from interface: MutableBitmap

Compute the bitwise-and of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Specified by:

and in interface MutableBitmap

Parameters:

mutableBitmap - other bitmap

xor

public void xor(MutableBitmap mutableBitmap)

Description copied from interface: MutableBitmap

Compute the bitwise-xor of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Specified by:

xor in interface MutableBitmap

Parameters:

mutableBitmap - other bitmap

andNot

public void andNot(MutableBitmap mutableBitmap)

Description copied from interface: MutableBitmap

Compute the bitwise-andNot of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Specified by:

andNot in interface MutableBitmap

Parameters:

mutableBitmap - other bitmap

getSizeInBytes

public int getSizeInBytes()

Description copied from interface: MutableBitmap

Return the size in bytes for the purpose of serialization to a ByteBuffer. Note that this is distinct from the memory usage.

Specified by:

getSizeInBytes in interface MutableBitmap

Returns:

the total set in bytes

add

public void add(int entry)

Description copied from interface: MutableBitmap

Add the specified integer to the bitmap. This is equivalent to setting the ith bit to the value 1.

Specified by:

add in interface MutableBitmap

Parameters:

entry - integer to be added

remove

public void remove(int entry)

Description copied from interface: MutableBitmap

Remove the specified integer to the bitmap. This is equivalent to setting the ith bit to the value 1.

Specified by:

remove in interface MutableBitmap

Parameters:

entry - integer to be remove

serialize

public void serialize(ByteBuffer buffer)

Description copied from interface: MutableBitmap

Write out a serialized (Immutable) version of the bitmap to the ByteBuffer. We preprend the serialized bitmap with a 4-byte int indicating the size in bytes. Thus getSizeInBytes() + 4 bytes are written. (These 4 bytes are required by ConciseSet but not by RoaringBitmap. Nevertheless, we always write them for the sake of simplicity, even if it wastes 4 bytes in some instances.)

Specified by:

serialize in interface MutableBitmap

Parameters:

buffer - where we write