Package com.globalmentor.collections.iterators

Class IteratorDecorator<E>

java.lang.Object

com.globalmentor.collections.iterators.AbstractIteratorDecorator<E>

com.globalmentor.collections.iterators.IteratorDecorator<E>

Type Parameters:

E - the type of elements returned by this iterator.

All Implemented Interfaces:

java.util.Enumeration<E>, java.util.Iterator<E>

Direct Known Subclasses:

AbstractConverterCollection.ConverterIterator, AbstractConverterList.ConverterIterator, CountedFilterIterator, ListIteratorDecorator

public class IteratorDecorator<E>
extends AbstractIteratorDecorator<E>

An iterator that wraps an existing iterator.

Author:

Garret Wilson

API Note:

This iterator also serves as an adapter, converting an iterator to an Enumeration.

Implementation Note:

Subclasses may override AbstractIteratorDecorator.hasNext() and/or AbstractIteratorDecorator.next(), and Enumeration compatibility will be maintained.

Constructor Summary

Constructors

Constructor	Description
IteratorDecorator(java.util.Iterator<E> iterator)	Iterator constructor.

Method Summary

Modifier and Type	Method	Description
protected java.util.Iterator<E>	getIterator()

Methods inherited from class com.globalmentor.collections.iterators.AbstractIteratorDecorator

hasMoreElements, hasNext, next, nextElement, 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.Enumeration

asIterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IteratorDecorator

public IteratorDecorator(@Nonnull
                         java.util.Iterator<E> iterator)

Iterator constructor.

Parameters:

iterator - The iterator this iterator will decorate.

Throws:

java.lang.NullPointerException - if the given iterator is null.

Method Detail

getIterator

protected java.util.Iterator<E> getIterator()

Specified by:

getIterator in class AbstractIteratorDecorator<E>

Returns:

The iterator this class decorates.