org.apache.commons.collections.bidimap

Class AbstractDualBidiMap.BidiMapIterator

Enclosing Class:
AbstractDualBidiMap
Implemented Interfaces:
Iterator, MapIterator, ResettableIterator

protected static class AbstractDualBidiMap.BidiMapIterator
extends java.lang.Object
implements MapIterator, ResettableIterator

Inner class MapIterator.

Field Summary

protected boolean
canRemove
Whether remove is allowed at present
protected Iterator
iterator
The iterator being wrapped
protected Map.Entry
last
The last returned entry
protected AbstractDualBidiMap
parent
The parent map

Constructor Summary

BidiMapIterator(AbstractDualBidiMap parent)
Constructor.

Method Summary

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.
Object
next()
Gets the next 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()

Field Details

canRemove

protected boolean canRemove
Whether remove is allowed at present

iterator

protected Iterator iterator
The iterator being wrapped

last

protected Map.Entry last
The last returned entry

parent

protected final AbstractDualBidiMap parent
The parent map

Constructor Details

BidiMapIterator

protected BidiMapIterator(AbstractDualBidiMap parent)
Constructor.
Parameters:
parent - the parent map

Method Details

getKey

public Object getKey()
Gets the current key, which is the key returned by the last call to next().
Specified by:
getKey in interface MapIterator
Returns:
the current key

getValue

public Object getValue()
Gets the current value, which is the value associated with the last key returned by next().
Specified by:
getValue in interface MapIterator
Returns:
the current value

hasNext

public boolean hasNext()
Checks to see if there are more entries still to be iterated.
Specified by:
hasNext in interface MapIterator
Returns:
true if the iterator has more elements

next

public Object next()
Gets the next key from the Map.
Specified by:
next in interface MapIterator
Returns:
the next key in the iteration

remove

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

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

Specified by:
remove in interface MapIterator

reset

public void reset()
Resets the iterator back to the position at which the iterator was created.
Specified by:
reset in interface ResettableIterator

setValue

public Object setValue(Object value)
Sets the value associated with the current key (optional operation).
Specified by:
setValue in interface MapIterator
Parameters:
value - the new value
Returns:
the previous value

toString

public String toString()

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