jstrachan 02/02/01 08:27:40
Modified: collections/src/java/org/apache/commons/collections
FilterIterator.java
Log:
Applied patch submitted by Michael Smith that clarifies the description of the
FilterIterator
Revision Changes Path
1.3 +7 -0
jakarta-commons/collections/src/java/org/apache/commons/collections/FilterIterator.java
Index: FilterIterator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/FilterIterator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FilterIterator.java 19 Oct 2001 20:18:21 -0000 1.2
+++ FilterIterator.java 1 Feb 2002 16:27:40 -0000 1.3
@@ -12,6 +12,10 @@
/** 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:[EMAIL PROTECTED]";>James Strachan</a>
* @author Jan Sorensen
@@ -41,6 +45,8 @@
// Iterator interface
//-------------------------------------------------------------------------
+
+ /** @return true if there is another object that matches the given predicate */
public boolean hasNext() {
if ( nextObjectSet ) {
return true;
@@ -49,6 +55,7 @@
}
}
+ /** @return the next object which matches the given predicate */
public Object next() {
if ( !nextObjectSet ) {
if (!setNextObject()) {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
