Package org.apache.commons.collections.iterators

Class UnmodifiableOrderedMapIterator

java.lang.Object
org.apache.commons.collections.iterators.UnmodifiableOrderedMapIterator
All Implemented Interfaces:
Iterator, MapIterator, OrderedIterator, OrderedMapIterator, Unmodifiable
@Deprecated(since="2021-04-30") public final class UnmodifiableOrderedMapIterator extends Object implements OrderedMapIterator, Unmodifiable
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
Decorates an ordered map iterator such that it cannot be modified.
Since:
Commons Collections 3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    static OrderedMapIterator
    decorate(OrderedMapIterator iterator)
    Deprecated.
    Decorates the specified iterator such that it cannot be modified.
    Object
    getKey()
    Deprecated.
    Gets the current key, which is the key returned by the last call to next().
    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.
    boolean
    hasPrevious()
    Deprecated.
    Checks to see if there is a previous entry that can be iterated to.
    Object
    next()
    Deprecated.
    Gets the next key from the Map.
    Object
    previous()
    Deprecated.
    Gets the previous key from the Map.
    void
    remove()
    Deprecated.
    Removes the last returned key from the underlying Map (optional operation).
    Object
    setValue(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 Details

    • decorate

      public static OrderedMapIterator decorate(OrderedMapIterator iterator)
      Deprecated.
      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()
      Deprecated.
      Description copied from interface: MapIterator
      Checks to see if there are more entries still to be iterated.
      Specified by:
      hasNext in interface Iterator
      Specified by:
      hasNext in interface MapIterator
      Returns:
      true if the iterator has more elements

    • next

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

    • hasPrevious

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

    • previous

      public Object previous()
      Deprecated.
      Description copied from interface: OrderedMapIterator
      Gets the previous key from the Map.
      Specified by:
      previous in interface OrderedIterator
      Specified by:
      previous in interface OrderedMapIterator
      Returns:
      the previous key in the iteration

    • getKey

      public 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 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 Object setValue(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 Iterator
      Specified by:
      remove in interface MapIterator