Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@348018 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2005-11-21 23:34:37 +00:00
parent e2f27b8f90
commit 8e19f208fa
2 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java/org/apache/commons/collections/iterators/FilterIterator.java
View File

@ -21,8 +21,10 @@ import java.util.NoSuchElementException;
import org.apache.commons.collections.Predicate;
/**
* Decorates an iterator such that only elements matching a predicate filter
* are returned.
* Decorates another {@link Iterator} using a predicate to filter elements.
* <p>
* This iterator decorates the underlying iterator, only allowing through
* those elements that match the specified {@link Predicate Predicate}.
*
* @since Commons Collections 1.0
* @version $Revision$ $Date$

25
src/java/org/apache/commons/collections/iterators/FilterListIterator.java
View File

@ -21,13 +21,11 @@ import java.util.NoSuchElementException;
import org.apache.commons.collections.Predicate;
/**
* A proxy {@link ListIterator ListIterator} which
* takes a {@link Predicate Predicate} instance to filter
* out objects from an underlying <code>ListIterator</code>
* instance. Only objects for which the specified
* <code>Predicate</code> evaluates to <code>true</code> are
* returned by the iterator.
*
* Decorates another {@link ListIterator} using a predicate to filter elements.
* <p>
* This iterator decorates the underlying iterator, only allowing through
* those elements that match the specified {@link Predicate Predicate}.
*
* @since Commons Collections 2.0
* @version $Revision$ $Date$
*
@ -72,10 +70,9 @@ public class FilterListIterator implements ListIterator {
//-----------------------------------------------------------------------
/**
* Constructs a new <code>FilterListIterator</code> that will not
* function until
* {@link ProxyListIterator#setListIterator(ListIterator) setListIterator}
* and {@link #setPredicate(Predicate) setPredicate} are invoked.
* Constructs a new <code>FilterListIterator</code> that will not function
* until {@link #setListIterator(ListIterator) setListIterator}
* and {@link #setPredicate(Predicate) setPredicate} are invoked.
*/
public FilterListIterator() {
super();
@ -105,10 +102,8 @@ public class FilterListIterator implements ListIterator {
}
/**
* Constructs a new <code>FilterListIterator</code> that will not
* function until
* {@link ProxyListIterator#setListIterator(ListIterator) setListIterator}
* is invoked.
* Constructs a new <code>FilterListIterator</code> that will not function
* until {@link #setListIterator(ListIterator) setListIterator} is invoked.
*
* @param predicate the predicate to use.
*/