ContainerBatchIterator (RoaringBitmap 0.9.0 API)

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

ArrayBatchIterator, ArrayBatchIterator, BitmapBatchIterator, BitmapBatchIterator, RunBatchIterator, RunBatchIterator
```
public interface ContainerBatchIterator
extends java.lang.Cloneable
```

Method Summary

All Methods Instance Methods Abstract 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.
`void`	`releaseContainer()`	Discard the reference to the container

- Method Detail
  - next
```
int next(int key,
         int[] buffer)
```
    Fills the buffer with values prefixed by the key, and returns how much of the buffer was used.
    
    Parameters:
    
    key - the prefix of the values
    
    buffer - the buffer to write values onto
    
    Returns:
    
    how many values were written.
  - hasNext
```
boolean hasNext()
```
    Whether the underlying container is exhausted or not
    
    Returns:
    
    true if there is data remaining
  - clone
```
ContainerBatchIterator clone()
```
    Creates a copy of the iterator.
    
    Returns:
    
    a clone of the current iterator
  - releaseContainer
```
void releaseContainer()
```
    Discard the reference to the container