ImmutableBitmap (io.druid:druid 0.10.0 API)

All Known Subinterfaces:

MutableBitmap

All Known Implementing Classes:

WrappedBitSetBitmap, WrappedConciseBitmap, WrappedImmutableBitSetBitmap, WrappedImmutableConciseBitmap, WrappedImmutableRoaringBitmap, WrappedRoaringBitmap
```
public interface ImmutableBitmap
```
This class is meant to represent a simple wrapper around an immutable bitmap class.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`compareTo(ImmutableBitmap other)`
`ImmutableBitmap`	`difference(ImmutableBitmap otherBitmap)` Compute the bitwise-andNot of this bitmap with another bitmap.
`boolean`	`get(int value)` Returns true if the bit at position value is set
`ImmutableBitmap`	`intersection(ImmutableBitmap otherBitmap)` Compute the bitwise-and of this bitmap with another bitmap.
`boolean`	`isEmpty()`
`org.roaringbitmap.IntIterator`	`iterator()`
`int`	`size()`
`byte[]`	`toBytes()`
`ImmutableBitmap`	`union(ImmutableBitmap otherBitmap)` Compute the bitwise-or of this bitmap with another bitmap.

- Method Detail
  - iterator
```
org.roaringbitmap.IntIterator iterator()
```
    Returns:
    
    an iterator over the set bits of this bitmap
  - size
```
int size()
```
    Returns:
    
    The number of bits set to true in this bitmap
  - toBytes
```
byte[] toBytes()
```
  - compareTo
```
int compareTo(ImmutableBitmap other)
```
  - isEmpty
```
boolean isEmpty()
```
    Returns:
    
    True if this bitmap is empty (contains no set bit)
  - get
```
boolean get(int value)
```
    Returns true if the bit at position value is set
    
    Parameters:
    
    value - the position to check
    
    Returns:
    
    true if bit is set
  - union
```
ImmutableBitmap union(ImmutableBitmap otherBitmap)
```
    Compute the bitwise-or of this bitmap with another bitmap. A new bitmap is generated. Note that the other bitmap should be of the same class instance.
    
    Parameters:
    
    otherBitmap - other bitmap
  - intersection
```
ImmutableBitmap intersection(ImmutableBitmap otherBitmap)
```
    Compute the bitwise-and of this bitmap with another bitmap. A new bitmap is generated. Note that the other bitmap should be of the same class instance.
    
    Parameters:
    
    otherBitmap - other bitmap
  - difference
```
ImmutableBitmap difference(ImmutableBitmap otherBitmap)
```
    Compute the bitwise-andNot of this bitmap with another bitmap. A new bitmap is generated. Note that the other bitmap should be of the same class instance.
    
    Parameters:
    
    otherBitmap - other bitmap

Interface ImmutableBitmap

Method Summary

Method Detail

iterator

size

toBytes

compareTo

isEmpty

get

union

intersection

difference