org.apache.commons.collections
Interface OrderedMapIterator<K,V>

All Superinterfaces:
Iterator<K>, MapIterator<K,V>, OrderedIterator<K>
All Known Implementing Classes:
AbstractLinkedMap.LinkMapIterator, AbstractOrderedMapIteratorDecorator, 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:
Commons Collections 3.0
Version:
$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:33:16 $
Author:
Matt Hall, John Watkinson, Stephen Colebourne

Method Summary
 boolean hasPrevious()
          Checks to see if there is a previous entry that can be iterated to.
 K previous()
          Gets the previous key from the Map.
 
Methods inherited from interface org.apache.commons.collections.MapIterator
getKey, getValue, hasNext, next, remove, setValue
 

Method Detail

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


Copyright © 2005-2005 Apache Software Foundation, Matt Hall, John Watkinson. All Rights Reserved.