Package org.apache.commons.collections.iterators

Class UnmodifiableMapIterator

  • All Implemented Interfaces:
    java.util.Iterator, MapIterator, Unmodifiable
    @Deprecated(since="2021-04-30")
public final class UnmodifiableMapIterator
extends java.lang.Object
implements MapIterator, Unmodifiable
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Decorates a map iterator such that it cannot be modified.
    Since:
    Commons Collections 3.0

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static MapIterator decorate​(MapIterator iterator)
      Deprecated.
      Decorates the specified iterator such that it cannot be modified.
      java.lang.Object getKey()
      Deprecated.
      Gets the current key, which is the key returned by the last call to next().
      java.lang.Object getValue()
      Deprecated.
      Gets the current value, which is the value associated with the last key returned by next().
      boolean hasNext()
      Deprecated.
      Checks to see if there are more entries still to be iterated.
      java.lang.Object next()
      Deprecated.
      Gets the next key from the Map.
      void remove()
      Deprecated.
      Removes the last returned key from the underlying Map (optional operation).
      java.lang.Object setValue​(java.lang.Object value)
      Deprecated.
      Sets the value associated with the current key (optional operation).

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Method Detail

      • decorate

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

      • hasNext

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

      • next

        public java.lang.Object next()
        Deprecated.
        Description copied from interface: MapIterator
        Gets the next key from the Map.
        Specified by:
        next in interface java.util.Iterator
        Specified by:
        next in interface MapIterator
        Returns:
        the next key in the iteration

      • getKey

        public java.lang.Object getKey()
        Deprecated.
        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
        Returns:
        the current key

      • getValue

        public java.lang.Object getValue()
        Deprecated.
        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
        Returns:
        the current value

      • setValue

        public java.lang.Object setValue​(java.lang.Object value)
        Deprecated.
        Description copied from interface: MapIterator
        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

      • remove

        public void remove()
        Deprecated.
        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 java.util.Iterator
        Specified by:
        remove in interface MapIterator