svn commit: r1714362 - in /commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4: ClosureUtils.java FactoryUtils.java TransformerUtils.java

[tn...@apache.org]

Author: tn
Date: Sat Nov 14 20:38:02 2015
New Revision: 1714362

URL: http://svn.apache.org/viewvc?rev=1714362&view=rev
Log:
[COLLECTIONS-580] Clarify class javadoc of utils that only unsafe classes are serializable anymore.

Modified:
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/ClosureUtils.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/FactoryUtils.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/TransformerUtils.java

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/ClosureUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/ClosureUtils.java?rev=1714362&r1=1714361&r2=1714362&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/ClosureUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/ClosureUtils.java Sat Nov 14 20:38:02 2015
@@ -37,7 +37,6 @@ import org.apache.commons.collections4.f
  * <li>Invoker - invokes a method on the input object
  * <li>For - repeatedly calls a closure for a fixed number of times
  * <li>While - repeatedly calls a closure while a predicate is true
- * <li>DoWhile - repeatedly calls a closure while a predicate is true
  * <li>Chained - chains two or more closures together
  * <li>If - calls one closure or another based on a predicate
  * <li>Switch - calls one closure based on one or more predicates
@@ -46,7 +45,14 @@ import org.apache.commons.collections4.f
  * <li>NOP - does nothing
  * <li>Exception - always throws an exception
  * </ul>
- * All the supplied closures are Serializable.
+ * <p>
+ * Since v4.1 only closures which are considered to be unsafe are
+ * Serializable. Closures considered to be unsafe for serialization are:
+ * <ul>
+ * <li>Invoker
+ * <li>For
+ * <li>While
+ * </ul>
  *
  * @since 3.0
  * @version $Id$

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/FactoryUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/FactoryUtils.java?rev=1714362&r1=1714361&r2=1714362&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/FactoryUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/FactoryUtils.java Sat Nov 14 20:38:02 2015
@@ -26,12 +26,18 @@ import org.apache.commons.collections4.f
  * for the Factory functor interface. The supplied factories are:
  * <ul>
  * <li>Prototype - clones a specified object
- * <li>Reflection - creates objects using reflection
+ * <li>Instantiate - creates objects using reflection
  * <li>Constant - always returns the same object
  * <li>Null - always returns null
  * <li>Exception - always throws an exception
  * </ul>
- * All the supplied factories are Serializable.
+ * <p>
+ * Since v4.1 only factories which are considered to be unsafe are
+ * Serializable. Factories considered to be unsafe for serialization are:
+ * <ul>
+ * <li>Prototype
+ * <li>Instantiate
+ * </ul>
  *
  * @since 3.0
  * @version $Id$

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/TransformerUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/TransformerUtils.java?rev=1714362&r1=1714361&r2=1714362&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/TransformerUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/TransformerUtils.java Sat Nov 14 20:38:02 2015
@@ -56,7 +56,14 @@ import org.apache.commons.collections4.f
  * <li>Exception - always throws an exception
  * <li>StringValue - returns a <code>java.lang.String</code> representation of the input object
  * </ul>
- * All the supplied transformers are Serializable.
+ * <p>
+ * Since v4.1 only transformers which are considered to be unsafe are
+ * Serializable. Transformers considered to be unsafe for serialization are:
+ * <ul>
+ * <li>Invoker
+ * <li>Clone
+ * <li>Instantiate
+ * </ul>
  *
  * @since 3.0
  * @version $Id$