Module roaringbitmap

Package org.roaringbitmap.buffer

Class BitmapBatchIterator

java.lang.Object

org.roaringbitmap.buffer.BitmapBatchIterator

All Implemented Interfaces:

Cloneable, ContainerBatchIterator

public final class BitmapBatchIterator
extends Object
implements ContainerBatchIterator

Constructor Summary

Constructors

Constructor	Description
BitmapBatchIterator(MappeableBitmapContainer bitmap)

Method Summary

Modifier and Type	Method	Description
void	advanceIfNeeded(char target)	Advance until the value.
ContainerBatchIterator	clone()	Creates a copy of the iterator.
boolean	hasNext()	Whether the underlying container is exhausted or not
int	next(int key, int[] buffer, int offset)	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.roaringbitmap.ContainerBatchIterator

next

Constructor Details

BitmapBatchIterator

public BitmapBatchIterator(MappeableBitmapContainer bitmap)

Method Details

next

public int next(int key,
 int[] buffer,
 int offset)

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

offset - the offset into 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

releaseContainer

public void releaseContainer()

Description copied from interface: ContainerBatchIterator

Discard the reference to the container

Specified by:

releaseContainer in interface ContainerBatchIterator

advanceIfNeeded

public void advanceIfNeeded(char target)

Description copied from interface: ContainerBatchIterator

Advance until the value.

Specified by:

advanceIfNeeded in interface ContainerBatchIterator

Parameters:

target - the value to advance to.