org.apache.commons.collections

Interface OrderedIterator

All Superinterfaces:
Iterator
Known Subinterfaces:
OrderedMapIterator
Known Implementing Classes:
AbstractLinkedList.LinkedListIterator, AbstractLinkedList.LinkedSubListIterator, AbstractLinkedMap.EntrySetIterator, AbstractLinkedMap.KeySetIterator, AbstractLinkedMap.LinkIterator, AbstractLinkedMap.LinkMapIterator, AbstractLinkedMap.ValuesIterator, AbstractOrderedMapIteratorDecorator, CursorableLinkedList.Cursor, DualTreeBidiMap.BidiOrderedMapIterator, EmptyOrderedIterator, EmptyOrderedMapIterator, UnmodifiableOrderedMapIterator

public interface OrderedIterator
extends Iterator

Defines an iterator that operates over a ordered collections.

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

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 element from the collection.

Method Details

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 element from the collection.
Returns:
the previous key in the iteration

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