Package org.HdrHistogram

Class LinearIterator

java.lang.Object
org.HdrHistogram.LinearIterator
All Implemented Interfaces:
Iterator<HistogramIterationValue>
public class LinearIterator extends Object implements Iterator<HistogramIterationValue>
Used for iterating through histogram values in linear steps. The iteration is performed in steps of valueUnitsPerBucket in size, terminating when all recorded histogram values are exhausted. Note that each iteration "bucket" includes values up to and including the next bucket boundary value.

  • Constructor Details

    • LinearIterator

      public LinearIterator(AbstractHistogram histogram, long valueUnitsPerBucket)
      Parameters:
      histogram - The histogram this iterator will operate on
      valueUnitsPerBucket - The size (in value units) of each bucket iteration.

  • Method Details

    • reset

      public void reset(long valueUnitsPerBucket)
      Reset iterator for re-use in a fresh iteration over the same histogram data set.
      Parameters:
      valueUnitsPerBucket - The size (in value units) of each bucket iteration.

    • 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>