FilterListIterator (Collections 2.1.1 release API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.collections.iterators
Class FilterListIterator

java.lang.Object
  |
  +--org.apache.commons.collections.iterators.ProxyListIterator
        |
        +--org.apache.commons.collections.iterators.FilterListIterator

All Implemented Interfaces:: java.util.Iterator, java.util.ListIterator

Direct Known Subclasses:: FilterListIterator

public class FilterListIterator
extends ProxyListIterator

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.

Since:: 2.0
Version:: $Revision: 1.1.2.1 $ $Date: 2004/05/22 12:14:04 $
Author:: Rodney Waldhoff

Constructor Summary

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

FilterListIterator(java.util.ListIterator iterator)
          Constructs a new FilterListIterator that will not function until setPredicate is invoked.

FilterListIterator(java.util.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(java.lang.Object o)
          Not supported.

Predicate getPredicate()
          Getter for the predicate property.

boolean hasNext()
          Invokes the underlying ListIterator.hasNext() method.

boolean hasPrevious()
          Invokes the underlying ListIterator.hasPrevious() method.

java.lang.Object next()
          Invokes the underlying ListIterator.next() method.

int nextIndex()
          Invokes the underlying ListIterator.nextIndex() method.

java.lang.Object previous()
          Invokes the underlying ListIterator.previous() method.

int previousIndex()
          Invokes the underlying ListIterator.previousIndex() method.

void remove()
          Not supported.

void set(java.lang.Object o)
          Not supported.

void setPredicate(Predicate predicate)
          Setter for the predicate property.

Methods inherited from class org.apache.commons.collections.iterators.ProxyListIterator

getListIterator, setListIterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterListIterator

public FilterListIterator()

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

FilterListIterator

public FilterListIterator(java.util.ListIterator iterator)

Constructs a new FilterListIterator that will not function until setPredicate is invoked.
Parameters:: iterator - the iterator to use

FilterListIterator

public FilterListIterator(java.util.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 Detail

add

public void add(java.lang.Object o)

Not supported.

Specified by:: add in interface java.util.ListIterator
Overrides:: add in class ProxyListIterator