org.apache.commons.collections.iterators (Commons Collections 3.1 API)

Package org.apache.commons.collections.iterators

This package contains implementations of the {@link java.util.Iterator Iterator} interface.

Class Summary
AbstractIteratorDecorator	Provides basic behaviour for decorating an iterator with extra functionality.
AbstractListIteratorDecorator	Provides basic behaviour for decorating a list iterator with extra functionality.
AbstractMapIteratorDecorator	Provides basic behaviour for decorating a map iterator with extra functionality.
AbstractOrderedMapIteratorDecorator	Provides basic behaviour for decorating an ordered map iterator with extra functionality.
ArrayIterator	Implements an {@link java.util.Iterator Iterator} over any array.
ArrayListIterator	Implements a {@link ListIterator} over an array.
CollatingIterator	Provides an ordered iteration over the elements contained in a collection of ordered Iterators.
EmptyIterator	Provides an implementation of an empty iterator.
EmptyListIterator	Provides an implementation of an empty list iterator.
EmptyMapIterator	Provides an implementation of an empty map iterator.
EmptyOrderedIterator	Provides an implementation of an empty ordered iterator.
EmptyOrderedMapIterator	Provides an implementation of an empty ordered map iterator.
EntrySetMapIterator	Implements a `MapIterator` using a Map entrySet.
EnumerationIterator	Adapter to make {@link Enumeration Enumeration} instances appear to be {@link Iterator Iterator} instances.
FilterIterator	Decorates an iterator such that only elements matching a predicate filter are returned.
FilterListIterator	A proxy {@link ListIterator ListIterator} which takes a {@link Predicate Predicate} instance to filter out objects from an underlying `ListIterator` instance.
IteratorChain	An IteratorChain is an Iterator that wraps a number of Iterators.
IteratorEnumeration	Adapter to make an {@link Iterator Iterator} instance appear to be an {@link Enumeration Enumeration} instance.
ListIteratorWrapper	As the wrapped Iterator is traversed, ListIteratorWrapper builds a LinkedList of its values, permitting all required operations of ListIterator.
LoopingIterator	An Iterator that restarts when it reaches the end.
ObjectArrayIterator	An {@link Iterator} over an array of objects.
ObjectArrayListIterator	Implements a {@link ListIterator} over an array of objects.
ObjectGraphIterator	An Iterator that can traverse multiple iterators down an object graph.
ProxyIterator	A Proxy {@link Iterator Iterator} which delegates its methods to a proxy instance.
ProxyListIterator	A proxy {@link ListIterator ListIterator} which delegates its methods to a proxy instance.
SingletonIterator	`SingletonIterator` is an {@link Iterator} over a single object instance.
SingletonListIterator	`SingletonIterator` is an {@link ListIterator} over a single object instance.
TransformIterator	Decorates an iterator such that each element returned is transformed.
UniqueFilterIterator	A FilterIterator which only returns "unique" Objects.
UnmodifiableIterator	Decorates an iterator such that it cannot be modified.
UnmodifiableListIterator	Decorates a list iterator such that it cannot be modified.
UnmodifiableMapIterator	Decorates a map iterator such that it cannot be modified.
UnmodifiableOrderedMapIterator	Decorates an ordered map iterator such that it cannot be modified.

Class Summary

AbstractIteratorDecorator

Provides basic behaviour for decorating an iterator with extra functionality.

AbstractListIteratorDecorator

Provides basic behaviour for decorating a list iterator with extra functionality.

AbstractMapIteratorDecorator

Provides basic behaviour for decorating a map iterator with extra functionality.

AbstractOrderedMapIteratorDecorator

Provides basic behaviour for decorating an ordered map iterator with extra functionality.

ArrayIterator

Implements an {@link java.util.Iterator Iterator} over any array.

ArrayListIterator

Implements a {@link ListIterator} over an array.

CollatingIterator

Provides an ordered iteration over the elements contained in a collection of ordered Iterators.

EmptyIterator

Provides an implementation of an empty iterator.

EmptyListIterator

Provides an implementation of an empty list iterator.

EmptyMapIterator

Provides an implementation of an empty map iterator.

EmptyOrderedIterator

Provides an implementation of an empty ordered iterator.

EmptyOrderedMapIterator

Provides an implementation of an empty ordered map iterator.

EntrySetMapIterator

Implements a MapIterator using a Map entrySet.

EnumerationIterator

Adapter to make {@link Enumeration Enumeration} instances appear to be {@link Iterator Iterator} instances.

FilterIterator

Decorates an iterator such that only elements matching a predicate filter are returned.

FilterListIterator

A proxy {@link ListIterator ListIterator} which takes a {@link Predicate Predicate} instance to filter out objects from an underlying ListIterator instance.

IteratorChain

An IteratorChain is an Iterator that wraps a number of Iterators.

IteratorEnumeration

Adapter to make an {@link Iterator Iterator} instance appear to be an {@link Enumeration Enumeration} instance.

ListIteratorWrapper

As the wrapped Iterator is traversed, ListIteratorWrapper builds a LinkedList of its values, permitting all required operations of ListIterator.

LoopingIterator

An Iterator that restarts when it reaches the end.

ObjectArrayIterator

An {@link Iterator} over an array of objects.

ObjectArrayListIterator

Implements a {@link ListIterator} over an array of objects.

ObjectGraphIterator

An Iterator that can traverse multiple iterators down an object graph.

ProxyIterator

A Proxy {@link Iterator Iterator} which delegates its methods to a proxy instance.

ProxyListIterator

A proxy {@link ListIterator ListIterator} which delegates its methods to a proxy instance.

SingletonIterator

SingletonIterator is an {@link Iterator} over a single object instance.

SingletonListIterator

SingletonIterator is an {@link ListIterator} over a single object instance.

TransformIterator

Decorates an iterator such that each element returned is transformed.

UniqueFilterIterator

A FilterIterator which only returns "unique" Objects.

UnmodifiableIterator

Decorates an iterator such that it cannot be modified.

UnmodifiableListIterator

Decorates a list iterator such that it cannot be modified.

UnmodifiableMapIterator

Decorates a map iterator such that it cannot be modified.

UnmodifiableOrderedMapIterator

Decorates an ordered map iterator such that it cannot be modified.

Package org.apache.commons.collections.iterators Description:

This package contains implementations of the {@link java.util.Iterator Iterator} interface.

You may also consider using {@link org.apache.commons.collections.IteratorUtils IteratorUtils}, which is a single class that uses static methods to construct instances of the classes in this package.