org.apache.commons.collections

Interface OrderedMapIterator

All Superinterfaces:
Iterator, MapIterator, OrderedIterator
Known Implementing Classes:
AbstractLinkedMap.LinkMapIterator, AbstractOrderedMapIteratorDecorator, DualTreeBidiMap.BidiOrderedMapIterator, EmptyOrderedMapIterator, UnmodifiableOrderedMapIterator

public interface OrderedMapIterator
extends MapIterator, OrderedIterator

Defines an iterator that operates over an ordered Map.

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

Version:
$Revision: 1.4 $ $Date: 2004/02/18 01:15:42 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

Method Summary

boolean
hasPrevious()
Checks to see if there is a previous entry that can be iterated to.
Object
previous()
Gets the previous key from the Map.

Methods inherited from interface org.apache.commons.collections.MapIterator

getKey, getValue, hasNext, next, remove, setValue

Methods inherited from interface org.apache.commons.collections.OrderedIterator

hasPrevious, previous

Method Details

hasPrevious

public boolean hasPrevious()
Checks to see if there is a previous entry that can be iterated to.
Specified by:
hasPrevious in interface OrderedIterator

Returns:
true if the iterator has a previous element


previous

public Object previous()
Gets the previous key from the Map.
Specified by:
previous in interface OrderedIterator

Returns:
the previous key in the iteration


Copyright © 2001-2005 Apache Software Foundation. All Rights Reserved.