BitmapBatchIterator (RoaringBitmap 0.8.1 API)

java.lang.Object
- org.roaringbitmap.buffer.BitmapBatchIterator

All Implemented Interfaces:: Cloneable, ContainerBatchIterator

public class BitmapBatchIterator
extends Object
implements ContainerBatchIterator

Constructor Summary

Constructors
Constructor Description

BitmapBatchIterator(MappeableBitmapContainer bitmap)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ContainerBatchIterator`	`clone()`	Creates a copy of the iterator.
`boolean`	`hasNext()`	Whether the underlying container is exhausted or not
`int`	`next(int key, int[] buffer)`	Fills the buffer with values prefixed by the key, and returns how much of the buffer was used.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BitmapBatchIterator
```
public BitmapBatchIterator(MappeableBitmapContainer bitmap)
```
- Method Detail
  - next
```
public int next(int key,
                int[] buffer)
```
    Description copied from interface: ContainerBatchIterator
    
    Fills the buffer with values prefixed by the key, and returns how much of the buffer was used.
    
    Specified by:
    
    next in interface ContainerBatchIterator
    
    Parameters:
    
    key - the prefix of the values
    
    buffer - the buffer to write values onto
    
    Returns:
    
    how many values were written.
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: ContainerBatchIterator
    
    Whether the underlying container is exhausted or not
    
    Specified by:
    
    hasNext in interface ContainerBatchIterator
    
    Returns:
    
    true if there is data remaining
  - clone
```
public ContainerBatchIterator clone()
```
    Description copied from interface: ContainerBatchIterator
    
    Creates a copy of the iterator.
    
    Specified by:
    
    clone in interface ContainerBatchIterator
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of the current iterator