Author: scolebourne
Date: Mon Nov 21 15:34:37 2005
New Revision: 348018

URL: http://svn.apache.org/viewcvs?rev=348018&view=rev
Log:
Improve javadoc

Modified:
    
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterIterator.java
    
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterListIterator.java

Modified: 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterIterator.java
URL: 
http://svn.apache.org/viewcvs/jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterIterator.java?rev=348018&r1=348017&r2=348018&view=diff
==============================================================================
--- 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterIterator.java
 (original)
+++ 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterIterator.java
 Mon Nov 21 15:34:37 2005
@@ -21,8 +21,10 @@
 import org.apache.commons.collections.Predicate;
 
 /** 
- * Decorates an iterator such that only elements matching a predicate filter
- * are returned.
+ * Decorates another [EMAIL PROTECTED] Iterator} using a predicate to filter 
elements.
+ * <p>
+ * This iterator decorates the underlying iterator, only allowing through
+ * those elements that match the specified [EMAIL PROTECTED] Predicate 
Predicate}.
  *
  * @since Commons Collections 1.0
  * @version $Revision$ $Date$

Modified: 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterListIterator.java
URL: 
http://svn.apache.org/viewcvs/jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterListIterator.java?rev=348018&r1=348017&r2=348018&view=diff
==============================================================================
--- 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterListIterator.java
 (original)
+++ 
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/FilterListIterator.java
 Mon Nov 21 15:34:37 2005
@@ -21,13 +21,11 @@
 import org.apache.commons.collections.Predicate;
 
 /** 
- * A proxy [EMAIL PROTECTED] ListIterator ListIterator} which 
- * takes a [EMAIL PROTECTED] Predicate Predicate} instance to filter
- * out objects from an underlying <code>ListIterator</code> 
- * instance. Only objects for which the specified 
- * <code>Predicate</code> evaluates to <code>true</code> are
- * returned by the iterator.
- * 
+ * Decorates another [EMAIL PROTECTED] ListIterator} using a predicate to 
filter elements.
+ * <p>
+ * This iterator decorates the underlying iterator, only allowing through
+ * those elements that match the specified [EMAIL PROTECTED] Predicate 
Predicate}.
+ *
  * @since Commons Collections 2.0
  * @version $Revision$ $Date$
  * 
@@ -72,10 +70,9 @@
     
     //-----------------------------------------------------------------------
     /**
-     *  Constructs a new <code>FilterListIterator</code> that will not 
-     *  function until 
-     *  [EMAIL PROTECTED] ProxyListIterator#setListIterator(ListIterator) 
setListIterator}
-     *  and [EMAIL PROTECTED] #setPredicate(Predicate) setPredicate} are 
invoked.
+     * Constructs a new <code>FilterListIterator</code> that will not function
+     * until [EMAIL PROTECTED] #setListIterator(ListIterator) setListIterator}
+     * and [EMAIL PROTECTED] #setPredicate(Predicate) setPredicate} are 
invoked.
      */
     public FilterListIterator() {
         super();
@@ -105,10 +102,8 @@
     }
 
     /**
-     * Constructs a new <code>FilterListIterator</code> that will not 
-     * function until 
-     * [EMAIL PROTECTED] ProxyListIterator#setListIterator(ListIterator) 
setListIterator}
-     * is invoked.
+     * Constructs a new <code>FilterListIterator</code> that will not function
+     * until [EMAIL PROTECTED] #setListIterator(ListIterator) setListIterator} 
is invoked.
      *
      * @param predicate  the predicate to use.
      */



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to