org.apache.commons.collections

Interface OrderedMapIterator

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.

Since: Commons Collections 3.0

Version: $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author: Stephen Colebourne

Method Summary
booleanhasPrevious()
Checks to see if there is a previous entry that can be iterated to.
Objectprevious()
Gets the previous key from the Map.

Method Detail

hasPrevious

public boolean hasPrevious()
Checks to see if there is a previous entry that can be iterated to.

Returns: true if the iterator has a previous element

previous

public Object previous()
Gets the previous key from the Map.

Returns: the previous key in the iteration

Throws: java.util.NoSuchElementException if the iteration is finished

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