org.apache.commons.collections4.iterators
Class UnmodifiableIterator<E>

java.lang.Object
  extended by org.apache.commons.collections4.iterators.UnmodifiableIterator<E>
All Implemented Interfaces:
Iterator<E>, Unmodifiable

public final class UnmodifiableIterator<E>
extends Object
implements Iterator<E>, Unmodifiable

Decorates an iterator such that it cannot be modified.

Attempts to modify it will result in an UnsupportedOperationException.

Since:
3.0
Version:
$Id: UnmodifiableIterator.java 1477802 2013-04-30 20:01:28Z tn $

Method Summary
 boolean hasNext()
           
 E next()
           
 void remove()
           
static
<E> Iterator<E>
unmodifiableIterator(Iterator<E> iterator)
          Decorates the specified iterator such that it cannot be modified.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

unmodifiableIterator

public static <E> Iterator<E> unmodifiableIterator(Iterator<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:
IllegalArgumentException - if the iterator is null

hasNext

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

next

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

remove

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


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.