commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Smith" <mich...@iammichael.org>
Subject [collections][PATCH] Ambiguous documentation in FilterIterator
Date Fri, 01 Feb 2002 06:07:07 GMT
Ambiguous documentation in
org/apache/commons/collections/FilterIterator.java

The FilterIterator does not specify whether it *returns* objects that
match the predicate, or whether it ignores (i.e. does not return)
objects that match the predicate.  This patch clarifies the API
documentation.

Regards,
Michael

Index:
D:/home/michael/dev/jakarta/jakarta-commons/collections/src/java/org/apa
che/commons/collections/FilterIterator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-commons/collections/src/java/org/apache/commons/
collections/FilterIterator.java,v
retrieving revision 1.2
diff -u -r1.2 FilterIterator.java
---
D:/home/michael/dev/jakarta/jakarta-commons/collections/src/java/org/apa
che/commons/collections/FilterIterator.java	19 Oct 2001 20:18:21 -0000
1.2
+++
D:/home/michael/dev/jakarta/jakarta-commons/collections/src/java/org/apa
che/commons/collections/FilterIterator.java	1 Feb 2002 05:49:32 -0000
@@ -11,7 +11,8 @@
 import java.util.NoSuchElementException;

 /** A Proxy {@link Iterator Iterator} which takes a {@link Predicate
Predicate} instance to filter
-  * out objects from an underlying {@link Iterator Iterator} instance.
+  * out objects from an underlying {@link Iterator Iterator} instance.
Only objects for which the
+  * specified <code>Predicate</code> evaluates to <code>true</code>
are
returned.
   *
   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
   * @author Jan Sorensen

Mime
View raw message