public class

EmptyOrderedMapIterator

extends Object
implements OrderedMapIterator ResettableIterator
java.lang.Object
   ↳ org.apache.commons.collections.iterators.EmptyOrderedMapIterator

Class Overview

Provides an implementation of an empty ordered map iterator.

Summary

Fields
public static final OrderedMapIterator INSTANCE Singleton instance of the iterator.
Protected Constructors
EmptyOrderedMapIterator()
Constructor.
Public Methods
void add(Object obj)
Object getKey()
Gets the current key, which is the key returned by the last call to next().
Object getValue()
Gets the current value, which is the value associated with the last key returned by next().
boolean hasNext()
Checks to see if there are more entries still to be iterated.
boolean hasPrevious()
Checks to see if there is a previous entry that can be iterated to.
Object next()
Gets the next key from the Map.
int nextIndex()
Object previous()
Gets the previous key from the Map.
int previousIndex()
void remove()
Removes the last returned key from the underlying Map (optional operation).
void reset()
Resets the iterator back to the position at which the iterator was created.
void set(Object obj)
Object setValue(Object value)
Sets the value associated with the current key (optional operation).
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.commons.collections.MapIterator
From interface org.apache.commons.collections.OrderedIterator
From interface org.apache.commons.collections.OrderedMapIterator
From interface org.apache.commons.collections.ResettableIterator

Fields

public static final OrderedMapIterator INSTANCE

Singleton instance of the iterator.

Protected Constructors

protected EmptyOrderedMapIterator ()

Constructor.

Public Methods

public void add (Object obj)

public Object getKey ()

Gets the current key, which is the key returned by the last call to next().

Returns
  • the current key

public Object getValue ()

Gets the current value, which is the value associated with the last key returned by next().

Returns
  • the current value

public boolean hasNext ()

Checks to see if there are more entries still to be iterated.

Returns
  • true if the iterator has more elements

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

public Object next ()

Gets the next key from the Map.

Returns
  • the next key in the iteration

public int nextIndex ()

public Object previous ()

Gets the previous key from the Map.

Returns
  • the previous key in the iteration

public int previousIndex ()

public void remove ()

Removes the last returned key from the underlying Map (optional operation).

This method can be called once per call to next().

public void reset ()

Resets the iterator back to the position at which the iterator was created.

public void set (Object obj)

public Object setValue (Object value)

Sets the value associated with the current key (optional operation).

Parameters
value the new value
Returns
  • the previous value