Interface OrderedMapIterator<K,V>

Type Parameters:
K - the type of the keys in the map
V - the type of the values in the map
All Superinterfaces:
Iterator<K>, MapIterator<K,V>, OrderedIterator<K>
All Known Implementing Classes:
AbstractLinkedMap.LinkMapIterator, AbstractSortedMapDecorator.SortedMapIterator, DualTreeBidiMap.BidiOrderedMapIterator, EmptyOrderedMapIterator, UnmodifiableOrderedMapIterator

public interface OrderedMapIterator<K,V> extends MapIterator<K,V>, OrderedIterator<K>
Defines an iterator that operates over an ordered Map.

This iterator allows both forward and reverse iteration through the map.

Since:
3.0
  • Method Details

    • hasPrevious

      boolean hasPrevious()
      Checks to see if there is a previous entry that can be iterated to.
      Specified by:
      hasPrevious in interface OrderedIterator<K>
      Returns:
      true if the iterator has a previous element
    • previous

      K previous()
      Gets the previous key from the Map.
      Specified by:
      previous in interface OrderedIterator<K>
      Returns:
      the previous key in the iteration
      Throws:
      NoSuchElementException - if the iteration is finished