svn commit: r1436833 - in /commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap: AbstractIterableGetMapDecorator.java TransformedMap.java

[tn...@apache.org]

Author: tn
Date: Tue Jan 22 10:44:13 2013
New Revision: 1436833

URL: http://svn.apache.org/viewvc?rev=1436833&view=rev
Log:
Complete javadoc, remove {@inheritDoc} tags as suggested on the ml.

Modified:
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java?rev=1436833&r1=1436832&r2=1436833&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java Tue Jan 22 10:44:13 2013
@@ -60,65 +60,38 @@ public class AbstractIterableGetMapDecor
         return map;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public boolean containsKey(final Object key) {
         return decorated().containsKey(key);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public boolean containsValue(final Object value) {
         return decorated().containsValue(value);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public Set<Map.Entry<K, V>> entrySet() {
         return decorated().entrySet();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public V get(final Object key) {
         return decorated().get(key);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public V remove(final Object key) {
         return decorated().remove(key);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public boolean isEmpty() {
         return decorated().isEmpty();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public Set<K> keySet() {
         return decorated().keySet();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public int size() {
         return decorated().size();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public Collection<V> values() {
         return decorated().values();
     }
@@ -131,9 +104,6 @@ public class AbstractIterableGetMapDecor
         return new EntrySetToMapIteratorAdapter<K, V>(entrySet());
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean equals(final Object object) {
         if (object == this) {
@@ -142,17 +112,11 @@ public class AbstractIterableGetMapDecor
         return decorated().equals(object);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int hashCode() {
         return decorated().hashCode();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public String toString() {
         return decorated().toString();

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java?rev=1436833&r1=1436832&r2=1436833&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java Tue Jan 22 10:44:13 2013
@@ -75,11 +75,16 @@ public class TransformedMap<J, K, U, V> 
      * If there are any elements already in the map being decorated, they are
      * NOT transformed.
      *
+     * @param <J>  the input key type
+     * @param <K>  the output key type
+     * @param <U>  the input value type
+     * @param <V>  the output value type
      * @param map the map to decorate, must not be null
      * @param keyTransformer the transformer to use for key conversion, null
-     * means no transformation
+     *   means no transformation
      * @param valueTransformer the transformer to use for value conversion, null
-     * means no transformation
+     *   means no transformation
+     * @return a new transformed map
      * @throws IllegalArgumentException if map is null
      */
     public static <J, K, U, V> TransformedMap<J, K, U, V> transformingMap(final Map<K, V> map,
@@ -198,23 +203,14 @@ public class TransformedMap<J, K, U, V> 
     }
 
     //-----------------------------------------------------------------------
-    /**
-     * {@inheritDoc}
-     */
     public V put(final J key, final U value) {
         return decorated().put(transformKey(key), transformValue(value));
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public void putAll(final Map<? extends J, ? extends U> mapToCopy) {
         decorated().putAll(transformMap(mapToCopy));
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public void clear() {
         decorated().clear();
     }