diff --git a/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java b/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java index c616194c48..641e5ba299 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java @@ -22,7 +22,7 @@ import org.apache.commons.collections4.Predicate; /** - * Decorates another {@link Iterator} using a predicate to filter elements. + * Decorates an {@link Iterator} using an optional predicate to filter elements. *

* This iterator decorates the underlying iterator, only allowing through * those elements that match the specified {@link Predicate Predicate}. @@ -33,16 +33,16 @@ */ public class FilterIterator implements Iterator { - /** The iterator being used */ + /** The iterator to be filtered. */ private Iterator iterator; - /** The predicate being used */ + /** The predicate to filter elements. */ private Predicate predicate; - /** The next object in the iteration */ + /** The next object in the iteration. */ private E nextObject; - /** Whether the next object has been calculated yet */ + /** Whether the next object has been calculated yet. */ private boolean nextObjectSet; /** @@ -77,7 +77,7 @@ public FilterIterator(final Iterator iterator, final Predicate getIterator() { return iterator; @@ -86,7 +86,7 @@ public Iterator getIterator() { /** * Gets the predicate this iterator is using. * - * @return the predicate + * @return the filtering predicate. */ public Predicate getPredicate() { return predicate;