You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2004/05/16 13:36:31 UTC
cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/functors ChainedTransformer.java InvokerTransformer.java PredicateTransformer.java StringValueTransformer.java FactoryTransformer.java CloneTransformer.java InstantiateTransformer.java ClosureTransformer.java MapTransformer.java ConstantTransformer.java ExceptionTransformer.java NOPTransformer.java SwitchTransformer.java
scolebourne 2004/05/16 04:36:31
Modified: collections/src/java/org/apache/commons/collections/functors
ChainedTransformer.java InvokerTransformer.java
PredicateTransformer.java
StringValueTransformer.java FactoryTransformer.java
CloneTransformer.java InstantiateTransformer.java
ClosureTransformer.java MapTransformer.java
ConstantTransformer.java ExceptionTransformer.java
NOPTransformer.java SwitchTransformer.java
Log:
Javadoc
Revision Changes Path
1.7 +8 -4 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ChainedTransformer.java
Index: ChainedTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ChainedTransformer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ChainedTransformer.java 13 Mar 2004 17:17:03 -0000 1.6
+++ ChainedTransformer.java 16 May 2004 11:36:31 -0000 1.7
@@ -22,7 +22,10 @@
import org.apache.commons.collections.Transformer;
/**
- * Transformer implementation that chains the specified closures together.
+ * Transformer implementation that chains the specified transformers together.
+ * <p>
+ * The input object is passed to the first transformer. The transformed result
+ * is passed to the second transformer and so on.
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
@@ -109,9 +112,10 @@
}
/**
- * Execute a list of transformers.
+ * Transforms the input to result via each decorated transformer
*
- * @param object the input object passed to each transformer
+ * @param object the input object passed to the first transformer
+ * @return the transformed result
*/
public Object transform(Object object) {
for (int i = 0; i < iTransformers.length; i++) {
1.6 +11 -6 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InvokerTransformer.java
Index: InvokerTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InvokerTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- InvokerTransformer.java 18 Feb 2004 00:59:20 -0000 1.5
+++ InvokerTransformer.java 16 May 2004 11:36:31 -0000 1.6
@@ -43,10 +43,12 @@
private final Object[] iArgs;
/**
- * Transformer method that performs validation.
+ * Gets an instanceof this transformer calling a specific method with specific values.
*
- * @param paramTypes the constructor parameter types
- * @param args the constructor arguments
+ * @param methodName the method name to call
+ * @param paramTypes the parameter types of the method
+ * @param args the arguments to pass to the method
+ * @return an invoker transformer
*/
public static Transformer getInstance(String methodName, Class[] paramTypes, Object[] args) {
if (methodName == null) {
@@ -94,7 +96,10 @@
}
/**
- * Return the result of instantiating the input Class object.
+ * Transforms the input to result by invoking a method on the input.
+ *
+ * @param input the input object to transform
+ * @return the transformed result, null if null input
*/
public Object transform(Object input) {
if (input == null) {
@@ -113,5 +118,5 @@
throw new FunctorException("InvokerTransformer: The method '" + iMethodName + "' on '" + input.getClass() + "' threw an exception", ex);
}
}
-
+
}
1.5 +6 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/PredicateTransformer.java
Index: PredicateTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/PredicateTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PredicateTransformer.java 13 Mar 2004 17:17:03 -0000 1.4
+++ PredicateTransformer.java 16 May 2004 11:36:31 -0000 1.5
@@ -63,7 +63,10 @@
}
/**
- * Call the predicate.
+ * Transforms the input to result by calling a predicate.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
return (iPredicate.evaluate(input) ? Boolean.TRUE : Boolean.FALSE);
@@ -71,6 +74,7 @@
/**
* Gets the predicate.
+ *
* @return the predicate
* @since Commons Collections 3.1
*/
1.7 +6 -3 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/StringValueTransformer.java
Index: StringValueTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/StringValueTransformer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- StringValueTransformer.java 31 Mar 2004 23:13:04 -0000 1.6
+++ StringValueTransformer.java 16 May 2004 11:36:31 -0000 1.7
@@ -53,10 +53,13 @@
}
/**
- * Return the String.valueOf for the object.
+ * Transforms the input to result by calling <code>String.valueOf</code>.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
return String.valueOf(input);
}
-
+
}
1.6 +7 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/FactoryTransformer.java
Index: FactoryTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/FactoryTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- FactoryTransformer.java 3 May 2004 12:03:11 -0000 1.5
+++ FactoryTransformer.java 16 May 2004 11:36:31 -0000 1.6
@@ -62,7 +62,11 @@
}
/**
- * Call the factory.
+ * Transforms the input by ignoring the input and returning the result of
+ * calling the decorated factory.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
return iFactory.create();
@@ -70,6 +74,7 @@
/**
* Gets the factory.
+ *
* @return the factory
* @since Commons Collections 3.1
*/
1.6 +6 -3 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/CloneTransformer.java
Index: CloneTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/CloneTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CloneTransformer.java 31 Mar 2004 23:13:04 -0000 1.5
+++ CloneTransformer.java 16 May 2004 11:36:31 -0000 1.6
@@ -55,7 +55,10 @@
}
/**
- * Do nothing
+ * Transforms the input to result by cloning it.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
if (input == null) {
@@ -63,5 +66,5 @@
}
return PrototypeFactory.getInstance(input).create();
}
-
+
}
1.6 +7 -3 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InstantiateTransformer.java
Index: InstantiateTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InstantiateTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- InstantiateTransformer.java 18 Feb 2004 00:59:20 -0000 1.5
+++ InstantiateTransformer.java 16 May 2004 11:36:31 -0000 1.6
@@ -48,6 +48,7 @@
*
* @param paramTypes the constructor parameter types
* @param args the constructor arguments
+ * @return an instantiate transformer
*/
public static Transformer getInstance(Class[] paramTypes, Object[] args) {
if (((paramTypes == null) && (args != null))
@@ -88,7 +89,10 @@
}
/**
- * Return the result of instantiating the input Class object.
+ * Transforms the input Class object to a result by instantiation.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
try {
@@ -110,5 +114,5 @@
throw new FunctorException("InstantiateTransformer: Constructor threw an exception", ex);
}
}
-
+
}
1.5 +6 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ClosureTransformer.java
Index: ClosureTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ClosureTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ClosureTransformer.java 13 Mar 2004 17:17:03 -0000 1.4
+++ ClosureTransformer.java 16 May 2004 11:36:31 -0000 1.5
@@ -63,7 +63,10 @@
}
/**
- * Call the closure.
+ * Transforms the input to result by executing a closure.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
iClosure.execute(input);
@@ -72,6 +75,7 @@
/**
* Gets the closure.
+ *
* @return the closure
* @since Commons Collections 3.1
*/
1.7 +6 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/MapTransformer.java
Index: MapTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/MapTransformer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- MapTransformer.java 13 Mar 2004 17:17:03 -0000 1.6
+++ MapTransformer.java 16 May 2004 11:36:31 -0000 1.7
@@ -64,7 +64,10 @@
}
/**
- * Returns the result by looking up in the map.
+ * Transforms the input to result by looking it up in a <code>Map</code>.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
return iMap.get(input);
@@ -72,6 +75,7 @@
/**
* Gets the map to lookup in.
+ *
* @return the map
* @since Commons Collections 3.1
*/
1.5 +6 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ConstantTransformer.java
Index: ConstantTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ConstantTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ConstantTransformer.java 13 Mar 2004 17:17:03 -0000 1.4
+++ ConstantTransformer.java 16 May 2004 11:36:31 -0000 1.5
@@ -67,7 +67,10 @@
}
/**
- * Always return constant.
+ * Transforms the input by ignoring it and returning the stored constant instead.
+ *
+ * @param input the input object which is ignored
+ * @return the stored constant
*/
public Object transform(Object input) {
return iConstant;
@@ -75,6 +78,7 @@
/**
* Gets the constant.
+ *
* @return the constant
* @since Commons Collections 3.1
*/
1.7 +8 -4 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ExceptionTransformer.java
Index: ExceptionTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ExceptionTransformer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ExceptionTransformer.java 31 Mar 2004 23:13:04 -0000 1.6
+++ ExceptionTransformer.java 16 May 2004 11:36:31 -0000 1.7
@@ -55,10 +55,14 @@
}
/**
- * Always throw an exception.
+ * Transforms the input to result by cloning it.
+ *
+ * @param input the input object to transform
+ * @return never
+ * @throws FunctorException always
*/
- public Object transform(Object object) {
+ public Object transform(Object input) {
throw new FunctorException("ExceptionTransformer invoked");
}
-
+
}
1.6 +6 -3 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/NOPTransformer.java
Index: NOPTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/NOPTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- NOPTransformer.java 31 Mar 2004 23:13:04 -0000 1.5
+++ NOPTransformer.java 16 May 2004 11:36:31 -0000 1.6
@@ -53,10 +53,13 @@
}
/**
- * Do nothing
+ * Transforms the input to result by doing nothing.
+ *
+ * @param input the input object to transform
+ * @return the transformed result which is the input
*/
public Object transform(Object input) {
return input;
}
-
+
}
1.5 +9 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/functors/SwitchTransformer.java
Index: SwitchTransformer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/SwitchTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SwitchTransformer.java 13 Mar 2004 17:17:03 -0000 1.4
+++ SwitchTransformer.java 16 May 2004 11:36:31 -0000 1.5
@@ -127,7 +127,11 @@
}
/**
- * Execute the transformer whose predicate returns true.
+ * Transforms the input to result by calling the transformer whose matching
+ * predicate returns true.
+ *
+ * @param input the input object to transform
+ * @return the transformed result
*/
public Object transform(Object input) {
for (int i = 0; i < iPredicates.length; i++) {
@@ -140,6 +144,7 @@
/**
* Gets the predicates, do not modify the array.
+ *
* @return the predicates
* @since Commons Collections 3.1
*/
@@ -149,6 +154,7 @@
/**
* Gets the transformers, do not modify the array.
+ *
* @return the transformers
* @since Commons Collections 3.1
*/
@@ -158,6 +164,7 @@
/**
* Gets the default transformer.
+ *
* @return the default transformer
* @since Commons Collections 3.1
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org