Apache Commons Collections 4.4 · org.apache.commons.collections4.iterators.UnmodifiableIterator

Modifier and Type	Field and Description
private final Iterator<? extends E>	iterator The iterator being decorated

Access	Constructor and Description
private	UnmodifiableIterator(final Iterator<? extends E> the iterator to decorate iterator) Constructor.

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public E	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
public static < the element type E> Iterator<E>	Returns: a new unmodifiable iterator unmodifiableIterator(final Iterator<? extends E> the iterator to decorate iterator) Decorates the specified iterator such that it cannot be modified.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

iterator	back to summary
private final Iterator<? extends E> iterator The iterator being decorated

UnmodifiableIterator	back to summary
private UnmodifiableIterator(final Iterator<? extends E> iterator) Constructor. Parameters iterator:Iterator<? extends E> the iterator to decorate

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public E next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:E the next element in the iteration Annotations @Override

back to summary

public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

unmodifiableIterator	back to summary
public static <E> Iterator<E> unmodifiableIterator(final Iterator<? extends E> iterator) Decorates the specified iterator such that it cannot be modified. If the iterator is already unmodifiable it is returned directly. Parameters <E> the element type iterator:Iterator<? extends E> the iterator to decorate Returns:Iterator<E> a new unmodifiable iterator Exceptions NullPointerException: if the iterator is null

unmodifiableIterator

back to summary

public static <E> Iterator<E> unmodifiableIterator(final Iterator<? extends E> iterator)

Decorates the specified iterator such that it cannot be modified.

If the iterator is already unmodifiable it is returned directly.

Parameters

<E>: the element type
iterator:Iterator<? extends E>: the iterator to decorate

Returns:Iterator<E>

a new unmodifiable iterator

Exceptions

NullPointerException:: if the iterator is null

public final Class UnmodifiableIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail