svn commit: r1180179 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java

[si...@apache.org]

Author: simonetripodi
Date: Fri Oct  7 19:30:55 2011
New Revision: 1180179

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

Modified:
    commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java?rev=1180179&r1=1180178&r2=1180179&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java (original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/ConditionalUnaryFunction.java Fri Oct  7 19:30:55 2011
@@ -38,6 +38,8 @@ import org.apache.commons.functor.UnaryP
  * an instance whose delegates are not all
  * <code>Serializable</code> will result in an exception.
  * </p>
+ * @param <A> the argument type.
+ * @param <T> the returned value type.
  * @version $Revision$ $Date$
  * @author Rodney Waldhoff
  */
@@ -47,12 +49,21 @@ public final class ConditionalUnaryFunct
      */
     private static final long serialVersionUID = -8152490481969255068L;
 
-    /** Base hash integer used to shift hash */
+    /** Base hash integer used to shift hash. */
     private static final int HASH_SHIFT = 4;
     // attributes
     // ------------------------------------------------------------------------
+    /**
+     * the condition to be evaluated.
+     */
     private final UnaryPredicate<? super A> ifPred;
+    /**
+     * the function executed if the condition is satisfied.
+     */
     private final UnaryFunction<? super A, ? extends T> thenFunc;
+    /**
+     * the function executed if the condition is not satisfied.
+     */
     private final UnaryFunction<? super A, ? extends T> elseFunc;
 
     // constructor