org.apache.commons.collections.iterators
Class UnmodifiableOrderedMapIterator

java.lang.Object
  |
  +--org.apache.commons.collections.iterators.UnmodifiableOrderedMapIterator
All Implemented Interfaces:
Iterator, MapIterator, OrderedIterator, OrderedMapIterator, Unmodifiable

public final class UnmodifiableOrderedMapIterator
extends Object
implements OrderedMapIterator, Unmodifiable

Decorates an ordered map iterator such that it cannot be modified.

Since:
Commons Collections 3.0
Version:
$Revision: 1.5 $ $Date: 2004/01/14 21:43:14 $
Author:
Stephen Colebourne

Method Summary
static OrderedMapIterator decorate(OrderedMapIterator iterator)
          Decorates the specified iterator such that it cannot be modified.
 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).
 Object setValue(Object value)
          Sets the value associated with the current key (optional operation).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

decorate

public static OrderedMapIterator decorate(OrderedMapIterator iterator)
Decorates the specified iterator such that it cannot be modified.
Parameters:
iterator - the iterator to decorate
Throws:
IllegalArgumentException - if the iterator is null

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

hasPrevious

public boolean hasPrevious()
Description copied from interface: OrderedMapIterator
Checks to see if there is a previous entry that can be iterated to.
Specified by:
hasPrevious in interface OrderedMapIterator
Following copied from interface: org.apache.commons.collections.OrderedMapIterator
Returns:
true if the iterator has a previous element

previous

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

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

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


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