com.yahoo.sketches.hll

Interface BucketIterator

All Known Implementing Classes:

CompositeBucketIterator

public interface BucketIterator

A BucketIterator is an iterator over bucket values in an Hll Fields object.

The general pattern for usage is you call next() and if that returns true, you will get values from getKey() and getValue(). If next() returned false, that means that iteration is complete; getKey() and getValue() become undefined.

Author:

Kevin Lang

Method Summary

Modifier and Type	Method and Description
int	getKey() Gets the index of the current bucket
byte	getValue() Gets the value of the current bucket
boolean	next() Should be called before each step of iteration (as well as immediately after initialization)

Method Detail

next

boolean next()

Should be called before each step of iteration (as well as immediately after initialization)

Returns:

true if there is a a bucket to return, false if iteration is complete

getKey

int getKey()

Gets the index of the current bucket

Returns:

the index of the current bucket

getValue

byte getValue()

Gets the value of the current bucket

Returns:

the value of the current bucket