Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.collections.iterators

Class FilterListIterator

Implemented Interfaces:
ListIterator
public class FilterListIterator
extends Object
implements ListIterator
A proxy ListIterator which takes a 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.
Version:
$Revision: 1.7 $ $Date: 2004/02/18 00:59:50 $
Author:
Rodney Waldhoff
Since:
Commons Collections 2.0

Constructor Summary

FilterListIterator()
Constructs a new FilterListIterator that will not function until setListIterator and setPredicate are invoked.
FilterListIterator(ListIterator iterator)
Constructs a new FilterListIterator that will not function until setPredicate is invoked.
FilterListIterator(ListIterator iterator, Predicate predicate)
Constructs a new FilterListIterator.
FilterListIterator(Predicate predicate)
Constructs a new FilterListIterator that will not function until 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 Details

FilterListIterator

public FilterListIterator()
Constructs a new FilterListIterator that will not function until setListIterator and setPredicate are invoked.

FilterListIterator

public FilterListIterator(ListIterator iterator)
Constructs a new FilterListIterator that will not function until 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 setListIterator is invoked.
Parameters:
predicate - the predicate to use.

Method Details

add

public void add(Object o)
Not supported.

getListIterator

public ListIterator getListIterator()
Gets the iterator this iterator is using.
Returns:
the iterator.

getPredicate

public Predicate getPredicate()
Gets the predicate this iterator is using.
Returns:
the predicate.

hasNext

public boolean hasNext()

hasPrevious

public boolean hasPrevious()

next

public Object next()

nextIndex

public int nextIndex()

previous

public Object previous()

previousIndex

public int previousIndex()

remove

public void remove()
Not supported.

set

public void set(Object o)
Not supported.

setListIterator

public void setListIterator(ListIterator iterator)
Sets the iterator for this iterator to use. If iteration has started, this effectively resets the iterator.
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

Overview Package Class Use Tree Index Deprecated About
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.