Package org.apache.commons.collections4.iterators

Class UnmodifiableIterator<E>

  • All Implemented Interfaces:
    java.util.Iterator<E>, Unmodifiable
    public final class UnmodifiableIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>, Unmodifiable
    Decorates an iterator such that it cannot be modified.

    Attempts to modify it will result in an UnsupportedOperationException.

    Since:
    3.0

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasNext()  
      E next()  
      void remove()  
      static <E> java.util.Iterator<E> unmodifiableIterator​(java.util.Iterator<? extends E> iterator)
      Decorates the specified iterator such that it cannot be modified.

      • 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

      • unmodifiableIterator

        public static <E> java.util.Iterator<E> unmodifiableIterator​(java.util.Iterator<? extends E> iterator)
        Decorates the specified iterator such that it cannot be modified.

        If the iterator is already unmodifiable it is returned directly.

        Type Parameters:
        E - the element type
        Parameters:
        iterator - the iterator to decorate
        Returns:
        a new unmodifiable iterator
        Throws:
        java.lang.NullPointerException - if the iterator is null

      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator<E>

      • next

        public E next()
        Specified by:
        next in interface java.util.Iterator<E>

      • remove

        public void remove()
        Specified by:
        remove in interface java.util.Iterator<E>