protected static class

DualTreeBidiMap.BidiOrderedMapIterator

extends Object
implements OrderedMapIterator ResettableIterator
java.lang.Object
   ↳ org.apache.commons.collections.bidimap.DualTreeBidiMap.BidiOrderedMapIterator

Class Overview

Inner class MapIterator.

Summary

Fields
protected ListIterator iterator The iterator being decorated
protected final AbstractDualBidiMap parent The parent map
Protected Constructors
DualTreeBidiMap.BidiOrderedMapIterator(AbstractDualBidiMap parent)
Constructor.
Public Methods
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.
Object previous()
Gets the previous key from the Map.
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.
Object setValue(Object value)
Sets the value associated with the current key (optional operation).
String toString()
[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

protected ListIterator iterator

The iterator being decorated

protected final AbstractDualBidiMap parent

The parent map

Protected Constructors

protected DualTreeBidiMap.BidiOrderedMapIterator (AbstractDualBidiMap parent)

Constructor.

Parameters
parent the parent map

Public Methods

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 Object previous ()

Gets the previous key from the Map.

Returns
  • the previous key in the iteration

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 Object setValue (Object value)

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

Parameters
value the new value
Returns
  • the previous value

public String toString ()