commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "James Strachan" <james_strac...@yahoo.co.uk>
Subject Re: [collections][PATCH] Ambiguous documentation in FilterIterator
Date Fri, 01 Feb 2002 16:24:25 GMT
Applied - thanks for the patch.

I don't know the Bag or SequencedHashMap code that well so I'll hold out for
someone else checking those patches in (and I'm a bit snowed under right
now).

James
----- Original Message -----
From: "Michael Smith" <michael@iammichael.org>
To: "'Jakarta Commons Developers List'" <commons-dev@jakarta.apache.org>
Sent: Friday, February 01, 2002 6:07 AM
Subject: [collections][PATCH] Ambiguous documentation in FilterIterator


> 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
>


----------------------------------------------------------------------------
----


> --
> To unsubscribe, e-mail:
<mailto:commons-dev-unsubscribe@jakarta.apache.org>
> For additional commands, e-mail:
<mailto:commons-dev-help@jakarta.apache.org>


_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com


--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message