org.apache.commons.collections.iterators

Class UnmodifiableIterator

java.lang.Object

org.apache.commons.collections.iterators.UnmodifiableIterator

All Implemented Interfaces:

java.util.Iterator, Unmodifiable

public final class UnmodifiableIterator
extends java.lang.Object
implements java.util.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) $

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Iterator	iterator The iterator being decorated

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UnmodifiableIterator(java.util.Iterator iterator) Constructor.

Method Summary

Modifier and Type	Method and Description
static java.util.Iterator	decorate(java.util.Iterator iterator) Decorates the specified iterator such that it cannot be modified.
boolean	hasNext()
java.lang.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

Field Detail

iterator

private java.util.Iterator iterator

The iterator being decorated

Constructor Detail

UnmodifiableIterator

private UnmodifiableIterator(java.util.Iterator iterator)

Constructor.

Parameters:

iterator - the iterator to decorate

Method Detail

decorate

public static java.util.Iterator decorate(java.util.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:

java.lang.IllegalArgumentException - if the iterator is null

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

next

public java.lang.Object next()

Specified by:

next in interface java.util.Iterator

remove

public void remove()

Specified by:

remove in interface java.util.Iterator