org.apache.commons.collections.bidimap
Class AbstractDualBidiMap.BidiMapIterator

java.lang.Object
  |
  +--org.apache.commons.collections.bidimap.AbstractDualBidiMap.BidiMapIterator
All Implemented Interfaces:
Iterator, MapIterator, ResettableIterator
Enclosing class:
AbstractDualBidiMap

protected static class AbstractDualBidiMap.BidiMapIterator
extends 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
protected AbstractDualBidiMap.BidiMapIterator(AbstractDualBidiMap parent)
           
 
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()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parent

protected final AbstractDualBidiMap parent
The parent map

iterator

protected Iterator iterator
The iterator being wrapped

last

protected Map.Entry last
The last returned entry

canRemove

protected boolean canRemove
Whether remove is allowed at present
Constructor Detail

AbstractDualBidiMap.BidiMapIterator

protected AbstractDualBidiMap.BidiMapIterator(AbstractDualBidiMap parent)
Method Detail

hasNext

public boolean hasNext()
Description copied from interface: MapIterator
Checks to see if there are more entries still to be iterated.
Specified by:
hasNext in interface MapIterator
Following copied from interface: org.apache.commons.collections.MapIterator
Returns:
true if the iterator has more elements

next

public Object next()
Description copied from interface: MapIterator
Gets the next key from the Map.
Specified by:
next in interface MapIterator
Following copied from interface: org.apache.commons.collections.MapIterator
Returns:
the next key in the iteration
Throws:
NoSuchElementException - if the iteration is finished

remove

public void remove()
Description copied from interface: MapIterator
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
Following copied from interface: org.apache.commons.collections.MapIterator
Throws:
UnsupportedOperationException - if remove is not supported by the map
IllegalStateException - if next() has not yet been called
IllegalStateException - if remove() has already been called since the last call to next()

getKey

public Object getKey()
Description copied from interface: MapIterator
Gets the current key, which is the key returned by the last call to next().
Specified by:
getKey in interface MapIterator
Following copied from interface: org.apache.commons.collections.MapIterator
Returns:
the current key
Throws:
IllegalStateException - if next() has not yet been called

getValue

public Object getValue()
Description copied from interface: MapIterator
Gets the current value, which is the value associated with the last key returned by next().
Specified by:
getValue in interface MapIterator
Following copied from interface: org.apache.commons.collections.MapIterator
Returns:
the current value
Throws:
IllegalStateException - if next() has not yet been called

setValue

public Object setValue(Object value)
Description copied from interface: MapIterator
Sets the value associated with the current key (optional operation).
Specified by:
setValue in interface MapIterator
Following copied from interface: org.apache.commons.collections.MapIterator
Parameters:
value - the new value
Returns:
the previous value
Throws:
UnsupportedOperationException - if setValue is not supported by the map
IllegalStateException - if next() has not yet been called
IllegalStateException - if remove() has been called since the last call to next()

reset

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

toString

public String toString()
Overrides:
toString in class Object


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