Package org.apache.commons.collections.iterators

Class UnmodifiableIterator

  • All Implemented Interfaces:
    java.util.Iterator, Unmodifiable
    @Deprecated(since="2021-04-30")
public final class UnmodifiableIterator
extends java.lang.Object
implements java.util.Iterator, 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 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 java.util.Iterator decorate​(java.util.Iterator iterator)
      Deprecated.
      Decorates the specified iterator such that it cannot be modified.
      boolean hasNext()
      Deprecated.
       
      java.lang.Object next()
      Deprecated.
       
      void remove()
      Deprecated.
       

      • 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 java.util.Iterator decorate​(java.util.Iterator iterator)
        Deprecated.
        Decorates the specified iterator such that it cannot be modified.

        If the iterator is already unmodifiable it is returned directly.

        Parameters:
        iterator - the iterator to decorate
        Throws:
        java.lang.IllegalArgumentException - if the iterator is null

      • hasNext

        public boolean hasNext()
        Deprecated.
        Specified by:
        hasNext in interface java.util.Iterator

      • next

        public java.lang.Object next()
        Deprecated.
        Specified by:
        next in interface java.util.Iterator

      • remove

        public void remove()
        Deprecated.
        Specified by:
        remove in interface java.util.Iterator