org.apache.commons.collections.iterators

Class FilterListIterator

public class FilterListIterator extends Object implements ListIterator

A proxy {@link ListIterator ListIterator} which takes a {@link Predicate Predicate} instance to filter out objects from an underlying ListIterator instance. Only objects for which the specified Predicate evaluates to true are returned by the iterator.

Since: Commons Collections 2.0

Version: $Revision: 1.7 $ $Date: 2004/02/18 00:59:50 $

Author: Rodney Waldhoff

Constructor Summary
	FilterListIterator() Constructs a new `FilterListIterator` that will not function until {@link ProxyListIterator#setListIterator(ListIterator) setListIterator} and {@link #setPredicate(Predicate) setPredicate} are invoked.
	FilterListIterator(ListIterator iterator) Constructs a new `FilterListIterator` that will not function until {@link #setPredicate(Predicate) setPredicate} is invoked.
	FilterListIterator(ListIterator iterator, Predicate predicate) Constructs a new `FilterListIterator`.
	FilterListIterator(Predicate predicate) Constructs a new `FilterListIterator` that will not function until {@link ProxyListIterator#setListIterator(ListIterator) setListIterator} is invoked.

Method Summary
void	add(Object o) Not supported.
ListIterator	getListIterator() Gets the iterator this iterator is using.
Predicate	getPredicate() Gets the predicate this iterator is using.
boolean	hasNext()
boolean	hasPrevious()
Object	next()
int	nextIndex()
Object	previous()
int	previousIndex()
void	remove() Not supported.
void	set(Object o) Not supported.
void	setListIterator(ListIterator iterator) Sets the iterator for this iterator to use.
void	setPredicate(Predicate predicate) Sets the predicate this the iterator to use.

Constructor Detail

FilterListIterator

public FilterListIterator()

Constructs a new FilterListIterator that will not function until {@link ProxyListIterator#setListIterator(ListIterator) setListIterator} and {@link #setPredicate(Predicate) setPredicate} are invoked.

FilterListIterator

public FilterListIterator(ListIterator iterator)

Constructs a new FilterListIterator that will not function until {@link #setPredicate(Predicate) setPredicate} is invoked.

Parameters: iterator the iterator to use

FilterListIterator

public FilterListIterator(ListIterator iterator, Predicate predicate)

Constructs a new FilterListIterator.

Parameters: iterator the iterator to use predicate the predicate to use

FilterListIterator

public FilterListIterator(Predicate predicate)

Constructs a new FilterListIterator that will not function until {@link ProxyListIterator#setListIterator(ListIterator) setListIterator} is invoked.

Parameters: predicate the predicate to use.

Returns: the iterator.

getPredicate

public Predicate getPredicate()

Gets the predicate this iterator is using.

Returns: the predicate.

Parameters: iterator the iterator to use

setPredicate

public void setPredicate(Predicate predicate)

Sets the predicate this the iterator to use.

Parameters: predicate the transformer to use