UnmodifiableIterator (Commons Collections 3.2.2 API)

java.lang.Object
- org.apache.commons.collections.iterators.UnmodifiableIterator

All Implemented Interfaces:

Iterator, Unmodifiable
```
public final class UnmodifiableIterator
extends Object
implements Iterator, Unmodifiable
```
Decorates an iterator such that it cannot be modified.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Iterator`	`decorate(Iterator iterator)`	Decorates the specified iterator such that it cannot be modified.
`boolean`	`hasNext()`
`Object`	`next()`
`void`	`remove()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Method Detail
  - decorate
```
public static Iterator decorate(Iterator iterator)
```
    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:
    
    IllegalArgumentException - if the iterator is null
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator
  - next
```
public Object next()
```
    Specified by:
    
    next in interface Iterator
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator