commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1175086 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java
Date Sat, 24 Sep 2011 00:43:47 GMT
Author: simonetripodi
Date: Sat Sep 24 00:43:46 2011
New Revision: 1175086

URL: http://svn.apache.org/viewvc?rev=1175086&view=rev
Log:
added missing javadoc comments

Modified:
    commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java?rev=1175086&r1=1175085&r2=1175086&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java
(original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/collection/TransformedIterator.java
Sat Sep 24 00:43:46 2011
@@ -22,6 +22,9 @@ import org.apache.commons.functor.UnaryF
 
 /**
  * Iterator that transforms another Iterator by applying a UnaryFunction to each returned
element.
+ *
+ * @param <E> the function argument type
+ * @param <T> the iterator elements type
  * @version $Revision$ $Date$
  * @author Rodney Waldhoff
  */
@@ -30,7 +33,13 @@ public final class TransformedIterator<E
     // attributes
     // ------------------------------------------------------------------------
 
+    /**
+     * The function to apply to each iterator element.
+     */
     private final UnaryFunction<? super E, ? extends T> function;
+    /**
+     * The wrapped iterator.
+     */
     private final Iterator<? extends E> iterator;
 
     // constructor
@@ -115,6 +124,9 @@ public final class TransformedIterator<E
     // ------------------------------------------------------------------------
     /**
      * Get a Transformed Iterator instance.
+     *
+     * @param <E> the function argument type
+     * @param <T> the iterator elements type
      * @param iter to decorate, if null result is null
      * @param func transforming function, cannot be null
      * @return Iterator<T>
@@ -128,6 +140,8 @@ public final class TransformedIterator<E
 
     /**
      * Get an Iterator instance that may be transformed.
+     *
+     * @param <E> the iterator elements type
      * @param iter to decorate, if null result is null
      * @param func transforming function, if null result is iter
      * @return Iterator<?>



Mime
View raw message