You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Michael Smith <mi...@iammichael.org> on 2002/02/01 07:07:07 UTC
[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
RE: [collections][PATCH] Ambiguous documentation in FilterIterator
Posted by "Michael A. Smith" <ia...@iammichael.org>.
On Fri, 1 Feb 2002, Paulo Gaspar wrote:
> Michael, keep reminding us of this and I will take a look at it as
> soon as I have just a bit more time. There is interesting on that
> class I assure you. (I am interested and I am sure I am not alone.)
I've already got it in my calender to repost next week if they haven't
been applied or rejected. If there's still result after that, I'll
probably start posting every other day. :)
regards,
michael
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
RE: [collections][PATCH] Ambiguous documentation in FilterIterator
Posted by Paulo Gaspar <pa...@krankikom.de>.
Michael, keep reminding us of this and I will take a look at it as
soon as I have just a bit more time. There is interesting on that
class I assure you. (I am interested and I am sure I am not alone.)
Have fun,
Paulo
> -----Original Message-----
> From: James Strachan [mailto:james_strachan@yahoo.co.uk]
> Sent: Friday, February 01, 2002 5:24 PM
> To: Jakarta Commons Developers List
> Subject: Re: [collections][PATCH] Ambiguous documentation in
> FilterIterator
>
>
> 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" <mi...@iammichael.org>
> To: "'Jakarta Commons Developers List'" <co...@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:
> <ma...@jakarta.apache.org>
> > For additional commands, e-mail:
> <ma...@jakarta.apache.org>
>
>
> _________________________________________________________
> Do You Yahoo!?
> Get your free @yahoo.com address at http://mail.yahoo.com
>
>
> --
> To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
For additional commands, e-mail:
<ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [collections][PATCH] Ambiguous documentation in FilterIterator
Posted by James Strachan <ja...@yahoo.co.uk>.
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" <mi...@iammichael.org>
To: "'Jakarta Commons Developers List'" <co...@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:
<ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>