Reduce scope of AbstractInputCheckedMapDecorator for v3.1

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131733 13f79535-47bb-0310-9956-ffa450edef68

RELEASE-NOTES.html

@@ -39,7 +39,6 @@ No deprecations have occurred.
 <li>MapBackedSet - Set created by decorating a map</li>
 <li>ReferenceIdentityMap - Similar to ReferenceMap, but matching keys and values by identity [26503]</li>
 <li>AbstractReferenceMap - New base class for reference maps [26503]</li>
-<li>AbstractInputCheckedMapDecorator - New base class for map decorators that validate or alter input</li>
 </ul>
 
 <center><h3>ENHANCEMENTS</h3></center>

src/java/org/apache/commons/collections/map/AbstractInputCheckedMapDecorator.java

@@ -34,13 +34,16 @@ import org.apache.commons.collections.set.AbstractSetDecorator;
  * the map. By overriding these methods, the input can be validated or manipulated.
  * In addition to the main map methods, the entrySet is also affected, which is
  * the hardest part of writing map implementations.
+ * <p>
+ * This class is package-scoped, and may be withdrawn or replaced in future
+ * versions of Commons Collections.
  *
  * @since Commons Collections 3.1
- * @version $Revision: 1.1 $ $Date: 2004/05/03 21:48:49 $
+ * @version $Revision: 1.2 $ $Date: 2004/05/21 22:01:04 $
  * 
  * @author Stephen Colebourne
  */
-public class AbstractInputCheckedMapDecorator
+abstract class AbstractInputCheckedMapDecorator
         extends AbstractMapDecorator {
 
     /**
@@ -61,45 +64,6 @@ public class AbstractInputCheckedMapDecorator
     }
 
     //-----------------------------------------------------------------------
-    /**
-     * Hook method called when a key is being added to the map using
-     * <code>put</code> or <code>putAll</code>.
-     * <p>
-     * An implementation may validate the key and throw an exception
-     * or it may transform the key into another object.
-     * The key may already exist in the map.
-     * <p>
-     * This implementation returns the input key.
-     * 
-     * @param key  the key to check
-     * @throws UnsupportedOperationException if the map may not be changed by put/putAll
-     * @throws IllegalArgumentException if the specified key is invalid
-     * @throws ClassCastException if the class of the specified key is invalid
-     * @throws NullPointerException if the specified key is null and nulls are invalid
-     */
-    protected Object checkPutKey(Object key) {
-        return key;
-    }
-
-    /**
-     * Hook method called when a new value is being added to the map using
-     * <code>put</code> or <code>putAll</code>.
-     * <p>
-     * An implementation may validate the value and throw an exception
-     * or it may transform the value into another object.
-     * <p>
-     * This implementation returns the input value.
-     * 
-     * @param value  the value to check
-     * @throws UnsupportedOperationException if the map may not be changed by put/putAll
-     * @throws IllegalArgumentException if the specified value is invalid
-     * @throws ClassCastException if the class of the specified value is invalid
-     * @throws NullPointerException if the specified value is null and nulls are invalid
-     */
-    protected Object checkPutValue(Object value) {
-        return value;
-    }
-
     /**
      * Hook method called when a value is being set using <code>setValue</code>.
      * <p>
@@ -114,9 +78,7 @@ public class AbstractInputCheckedMapDecorator
      * @throws ClassCastException if the class of the specified value is invalid
      * @throws NullPointerException if the specified value is null and nulls are invalid
      */
-    protected Object checkSetValue(Object value) {
-        return value;
-    }
+    protected abstract Object checkSetValue(Object value);
 
     /**
      * Hook method called to determine if <code>checkSetValue</code> has any effect.
@@ -132,43 +94,7 @@ public class AbstractInputCheckedMapDecorator
         return true;
     }
 
-    /**
-     * Checks each element in the specified map, creating a new map.
-     * <p>
-     * This method is used by <code>putAll</code> to check all the elements
-     * before adding them to the map.
-     * <p>
-     * This implementation builds a <code>LinkedMap</code> to preserve the order
-     * of the input map.
-     * 
-     * @param map  the map to transform
-     * @throws the transformed object
-     */
-    protected Map checkMap(Map map) {
-        Map result = new LinkedMap(map.size());
-        for (Iterator it = map.entrySet().iterator(); it.hasNext(); ) {
-            Map.Entry entry = (Map.Entry) it.next();
-            result.put(checkPutKey(entry.getKey()), checkPutValue(entry.getValue()));
-        }
-        return result;
-    }
-
     //-----------------------------------------------------------------------
-    public Object put(Object key, Object value) {
-        key = checkPutKey(key);
-        value = checkPutValue(value);
-        return getMap().put(key, value);
-    }
-
-    public void putAll(Map mapToCopy) {
-        if (mapToCopy.size() == 0) {
-            return;
-        } else {
-            mapToCopy = checkMap(mapToCopy);
-            getMap().putAll(mapToCopy);
-        }
-    }
-
     public Set entrySet() {
         if (isSetValueChecking()) {
             return new EntrySet(map.entrySet(), this);

src/java/org/apache/commons/collections/map/PredicatedMap.java

@@ -38,7 +38,7 @@ import org.apache.commons.collections.Predicate;
  * This class is Serializable from Commons Collections 3.1.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.12 $ $Date: 2004/05/21 21:38:49 $
+ * @version $Revision: 1.13 $ $Date: 2004/05/21 22:01:04 $
  * 
  * @author Stephen Colebourne
  * @author Paul Jack
@@ -120,9 +120,6 @@ public class PredicatedMap
     }
 
     //-----------------------------------------------------------------------
-    // The validate method exists for backwards compatability - in an ideal
-    // world, it wouldn't and the superclass methods checkPutKey/checkPutValue
-    // would be overridden instead
     /**
      * Validates a key value pair.
      * 

src/java/org/apache/commons/collections/map/TransformedMap.java

@@ -35,7 +35,7 @@ import org.apache.commons.collections.Transformer;
  * This class is Serializable from Commons Collections 3.1.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.9 $ $Date: 2004/05/03 21:48:49 $
+ * @version $Revision: 1.10 $ $Date: 2004/05/21 22:01:04 $
  * 
  * @author Stephen Colebourne
  */
@@ -111,10 +111,6 @@ public class TransformedMap
     }
 
     //-----------------------------------------------------------------------
-    // The transformKey/transformValue/transformMap methods exist for backwards
-    // compatability - in an ideal world, they wouldn't and the superclass
-    // methods checkPutKey/checkPutValue would be overridden instead
-
     /**
      * Transforms a key.
      * <p>