Package org.apache.commons.collections

Interface OrderedMapIterator

All Superinterfaces:

java.util.Iterator, MapIterator, OrderedIterator

All Known Implementing Classes:

AbstractOrderedMapIteratorDecorator, EmptyOrderedMapIterator, UnmodifiableOrderedMapIterator

@Deprecated(since="2021-04-30")
public interface OrderedMapIterator
extends MapIterator, OrderedIterator

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

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

Method Summary

Modifier and Type	Method	Description
boolean	hasPrevious()	Deprecated. Checks to see if there is a previous entry that can be iterated to.
java.lang.Object	previous()	Deprecated. Gets the previous key from the Map.

Methods inherited from interface java.util.Iterator

forEachRemaining

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

getKey, getValue, hasNext, next, remove, setValue

Method Detail

hasPrevious

boolean hasPrevious()

Deprecated.

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

java.lang.Object previous()

Deprecated.

Gets the previous key from the Map.

Specified by:

previous in interface OrderedIterator

Returns:

the previous key in the iteration

Throws:

java.util.NoSuchElementException - if the iteration is finished