CyclicIteration (Apache Hadoop HDFS 3.5.0 API)
Description: declaration: package: org.apache.hadoop.hdfs.util, class: CyclicIteration

Package org.apache.hadoop.hdfs.util

# Class CyclicIteration<K,V>

java.lang.Object
org.apache.hadoop.hdfs.util.CyclicIteration<K,V>

All Implemented Interfaces:
  `Iterable<Map.Entry<K,V>>`

@Private @Unstable public class CyclicIteration<K,V> extends Object implements Iterable<Map.Entry<K,V>>
Provide an cyclic `Iterator` for a `NavigableMap`. The `Iterator` navigates the entries of the map according to the map's ordering. If the `Iterator` hits the last entry of the map, it will then continue from the first entry.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CyclicIteration(NavigableMap<K,V> navigablemap, K startingkey)`
  Construct an `Iterable` object, so that an `Iterator` can be created for iterating the given `NavigableMap`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Iterator<Map.Entry<K,V>>`
  `iterator()`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface java.lang.Iterable

  `forEach, spliterator`

- ## Constructor Details

  - ### CyclicIteration

    public CyclicIteration(NavigableMap<K,V> navigablemap, K startingkey)
    Construct an `Iterable` object, so that an `Iterator` can be created for iterating the given `NavigableMap`. The iteration begins from the starting key exclusively.

- ## Method Details

  - ### iterator

    public Iterator<Map.Entry<K,V>> iterator()
    Specified by:
      `iterator` in interface `Iterable<K>`