Package org.HdrHistogram

Class RecordedValuesIterator

java.lang.Object

org.HdrHistogram.RecordedValuesIterator

All Implemented Interfaces:

Iterator<HistogramIterationValue>

public class RecordedValuesIterator
extends Object
implements Iterator<HistogramIterationValue>

Used for iterating through all recorded histogram values using the finest granularity steps supported by the underlying representation. The iteration steps through all non-zero recorded value counts, and terminates when all recorded histogram values are exhausted.

Constructor Summary

Constructors

Constructor	Description
RecordedValuesIterator(AbstractHistogram histogram)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Returns true if the iteration has more elements.
HistogramIterationValue	next()	Returns the next element in the iteration.
void	remove()	Not supported.
void	reset()	Reset iterator for re-use in a fresh iteration over the same histogram data set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Constructor Details

RecordedValuesIterator

public RecordedValuesIterator(AbstractHistogram histogram)

Parameters:

histogram - The histogram this iterator will operate on

Method Details

reset

public void reset()

Reset iterator for re-use in a fresh iteration over the same histogram data set.

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<HistogramIterationValue>

Returns:

true if the iterator has more elements.

next

public HistogramIterationValue next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<HistogramIterationValue>

Returns:

the HistogramIterationValue associated with the next element in the iteration.

remove

public void remove()

Not supported. Will throw an UnsupportedOperationException.

Specified by:

remove in interface Iterator<HistogramIterationValue>