From 902ee25dcfb3f2a14d3dd8a9778f16b68611baaa Mon Sep 17 00:00:00 2001
From: Thomas Neidhart <tn@apache.org>
Date: Sat, 23 Jun 2012 14:33:48 +0000
Subject: [PATCH] [COLLECTIONS-231] return specific type rather than base type
 in factory methods.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1353132 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/commons/collections/map/DefaultedMap.java    | 4 ++--
 .../org/apache/commons/collections/map/FixedSizeMap.java    | 2 +-
 .../apache/commons/collections/map/FixedSizeSortedMap.java  | 2 +-
 .../org/apache/commons/collections/map/LazySortedMap.java   | 5 +++--
 .../org/apache/commons/collections/map/ListOrderedMap.java  | 2 +-
 .../org/apache/commons/collections/map/MultiValueMap.java   | 6 ++++--
 .../org/apache/commons/collections/map/PredicatedMap.java   | 4 +++-
 .../apache/commons/collections/map/PredicatedSortedMap.java | 2 +-
 .../org/apache/commons/collections/map/TransformedMap.java  | 4 ++--
 .../commons/collections/map/TransformedSortedMap.java       | 4 ++--
 10 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/src/main/java/org/apache/commons/collections/map/DefaultedMap.java b/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
index eb99c1bc6..5a1c25d66 100644
--- a/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
@@ -82,7 +82,7 @@ public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Se
      * @param defaultValue  the default value to return when the key is not found
      * @throws IllegalArgumentException if map is null
      */
-    public static <K, V> Map<K, V> defaultedMap(Map<K, V> map, V defaultValue) {
+    public static <K, V> DefaultedMap<K, V> defaultedMap(Map<K, V> map, V defaultValue) {
         return new DefaultedMap<K, V>(map, ConstantTransformer.constantTransformer(defaultValue));
     }
 
@@ -96,7 +96,7 @@ public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Se
      * @param factory  the factory to use to create entries, must not be null
      * @throws IllegalArgumentException if map or factory is null
      */
-    public static <K, V> IterableMap<K, V> defaultedMap(Map<K, V> map, Factory<? extends V> factory) {
+    public static <K, V> DefaultedMap<K, V> defaultedMap(Map<K, V> map, Factory<? extends V> factory) {
         if (factory == null) {
             throw new IllegalArgumentException("Factory must not be null");
         }
diff --git a/src/main/java/org/apache/commons/collections/map/FixedSizeMap.java b/src/main/java/org/apache/commons/collections/map/FixedSizeMap.java
index f9647442e..3e3920e8f 100644
--- a/src/main/java/org/apache/commons/collections/map/FixedSizeMap.java
+++ b/src/main/java/org/apache/commons/collections/map/FixedSizeMap.java
@@ -69,7 +69,7 @@ public class FixedSizeMap<K, V>
      * @param map  the map to decorate, must not be null
      * @throws IllegalArgumentException if map is null
      */
-    public static <K, V> IterableMap<K, V> fixedSizeMap(Map<K, V> map) {
+    public static <K, V> FixedSizeMap<K, V> fixedSizeMap(Map<K, V> map) {
         return new FixedSizeMap<K, V>(map);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/FixedSizeSortedMap.java b/src/main/java/org/apache/commons/collections/map/FixedSizeSortedMap.java
index 52cd6a69b..6111867e5 100644
--- a/src/main/java/org/apache/commons/collections/map/FixedSizeSortedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/FixedSizeSortedMap.java
@@ -70,7 +70,7 @@ public class FixedSizeSortedMap<K, V>
      * @param map  the map to decorate, must not be null
      * @throws IllegalArgumentException if map is null
      */
-    public static <K, V> SortedMap<K, V> fixedSizeSortedMap(SortedMap<K, V> map) {
+    public static <K, V> FixedSizeSortedMap<K, V> fixedSizeSortedMap(SortedMap<K, V> map) {
         return new FixedSizeSortedMap<K, V>(map);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/LazySortedMap.java b/src/main/java/org/apache/commons/collections/map/LazySortedMap.java
index 31f0176a2..e2910833a 100644
--- a/src/main/java/org/apache/commons/collections/map/LazySortedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/LazySortedMap.java
@@ -72,7 +72,7 @@ public class LazySortedMap<K,V>
      * @param factory  the factory to use, must not be null
      * @throws IllegalArgumentException if map or factory is null
      */
-    public static <K, V> SortedMap<K, V> lazySortedMap(SortedMap<K, V> map, Factory<? extends V> factory) {
+    public static <K, V> LazySortedMap<K, V> lazySortedMap(SortedMap<K, V> map, Factory<? extends V> factory) {
         return new LazySortedMap<K,V>(map, factory);
     }
 
@@ -83,7 +83,8 @@ public class LazySortedMap<K,V>
      * @param factory  the factory to use, must not be null
      * @throws IllegalArgumentException if map or factory is null
      */
-    public static <K, V> SortedMap<K, V> lazySortedMap(SortedMap<K, V> map, Transformer<? super K, ? extends V> factory) {
+    public static <K, V> LazySortedMap<K, V> lazySortedMap(SortedMap<K, V> map,
+                                                           Transformer<? super K, ? extends V> factory) {
         return new LazySortedMap<K,V>(map, factory);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java b/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
index b7606b24a..4236ea2a4 100644
--- a/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
@@ -96,7 +96,7 @@ public class ListOrderedMap<K, V>
      * @param map  the map to decorate, must not be null
      * @throws IllegalArgumentException if map is null
      */
-    public static <K, V> OrderedMap<K, V> listOrderedMap(Map<K, V> map) {
+    public static <K, V> ListOrderedMap<K, V> listOrderedMap(Map<K, V> map) {
         return new ListOrderedMap<K, V>(map);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/MultiValueMap.java b/src/main/java/org/apache/commons/collections/map/MultiValueMap.java
index e0033e360..a6ec79217 100644
--- a/src/main/java/org/apache/commons/collections/map/MultiValueMap.java
+++ b/src/main/java/org/apache/commons/collections/map/MultiValueMap.java
@@ -95,7 +95,8 @@ public class MultiValueMap<K, V> extends AbstractMapDecorator<K, Object> impleme
      * @param map  the map to wrap
      * @param collectionClass  the type of the collection class
      */
-    public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, ? super C> map, Class<C> collectionClass) {
+    public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, ? super C> map,
+                                                                                    Class<C> collectionClass) {
         return new MultiValueMap<K, V>(map, new ReflectionFactory<C>(collectionClass));
     }
 
@@ -106,7 +107,8 @@ public class MultiValueMap<K, V> extends AbstractMapDecorator<K, Object> impleme
      * @param map  the map to decorate
      * @param collectionFactory  the collection factory (must return a Collection object).
      */
-    public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, ? super C> map, Factory<C> collectionFactory) {
+    public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, ? super C> map,
+                                                                                    Factory<C> collectionFactory) {
         return new MultiValueMap<K, V>(map, collectionFactory);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/PredicatedMap.java b/src/main/java/org/apache/commons/collections/map/PredicatedMap.java
index 57853ba1e..55dcf537f 100644
--- a/src/main/java/org/apache/commons/collections/map/PredicatedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/PredicatedMap.java
@@ -75,7 +75,9 @@ public class PredicatedMap<K, V>
      * @param valuePredicate  the predicate to validate to values, null means no check
      * @throws IllegalArgumentException if the map is null
      */
-    public static <K, V> IterableMap<K, V> predicatedMap(Map<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) {
+    public static <K, V> PredicatedMap<K, V> predicatedMap(Map<K, V> map,
+                                                           Predicate<? super K> keyPredicate,
+                                                           Predicate<? super V> valuePredicate) {
         return new PredicatedMap<K, V>(map, keyPredicate, valuePredicate);
     }
 
diff --git a/src/main/java/org/apache/commons/collections/map/PredicatedSortedMap.java b/src/main/java/org/apache/commons/collections/map/PredicatedSortedMap.java
index fe3418e5c..a3f2fbff8 100644
--- a/src/main/java/org/apache/commons/collections/map/PredicatedSortedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/PredicatedSortedMap.java
@@ -62,7 +62,7 @@ public class PredicatedSortedMap<K, V> extends PredicatedMap<K, V> implements So
      * @param valuePredicate  the predicate to validate to values, null means no check
      * @throws IllegalArgumentException if the map is null
      */
-    public static <K, V> SortedMap<K, V> predicatedSortedMap(SortedMap<K, V> map,
+    public static <K, V> PredicatedSortedMap<K, V> predicatedSortedMap(SortedMap<K, V> map,
             Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) {
         return new PredicatedSortedMap<K, V>(map, keyPredicate, valuePredicate);
     }
diff --git a/src/main/java/org/apache/commons/collections/map/TransformedMap.java b/src/main/java/org/apache/commons/collections/map/TransformedMap.java
index 8128a73ef..8ad79b67a 100644
--- a/src/main/java/org/apache/commons/collections/map/TransformedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/TransformedMap.java
@@ -72,7 +72,7 @@ public class TransformedMap<K, V>
      * @param valueTransformer  the transformer to use for value conversion, null means no transformation
      * @throws IllegalArgumentException if map is null
      */
-    public static <K, V> IterableMap<K, V> transformingMap(Map<K, V> map,
+    public static <K, V> TransformedMap<K, V> transformingMap(Map<K, V> map,
             Transformer<? super K, ? extends K> keyTransformer,
             Transformer<? super V, ? extends V> valueTransformer) {
         return new TransformedMap<K, V>(map, keyTransformer, valueTransformer);
@@ -92,7 +92,7 @@ public class TransformedMap<K, V>
      * @throws IllegalArgumentException if map is null
      * @since Commons Collections 3.2
      */
-    public static <K, V> Map<K, V> transformedMap(Map<K, V> map,
+    public static <K, V> TransformedMap<K, V> transformedMap(Map<K, V> map,
             Transformer<? super K, ? extends K> keyTransformer,
             Transformer<? super V, ? extends V> valueTransformer) {
         TransformedMap<K, V> decorated = new TransformedMap<K, V>(map, keyTransformer, valueTransformer);
diff --git a/src/main/java/org/apache/commons/collections/map/TransformedSortedMap.java b/src/main/java/org/apache/commons/collections/map/TransformedSortedMap.java
index f52ffb94f..adc9c9ab0 100644
--- a/src/main/java/org/apache/commons/collections/map/TransformedSortedMap.java
+++ b/src/main/java/org/apache/commons/collections/map/TransformedSortedMap.java
@@ -62,7 +62,7 @@ public class TransformedSortedMap<K, V>
      * @param valueTransformer  the predicate to validate to values, null means no transformation
      * @throws IllegalArgumentException if the map is null
      */
-    public static <K, V> SortedMap<K, V> transformingSortedMap(SortedMap<K, V> map,
+    public static <K, V> TransformedSortedMap<K, V> transformingSortedMap(SortedMap<K, V> map,
             Transformer<? super K, ? extends K> keyTransformer,
             Transformer<? super V, ? extends V> valueTransformer) {
         return new TransformedSortedMap<K, V>(map, keyTransformer, valueTransformer);
@@ -82,7 +82,7 @@ public class TransformedSortedMap<K, V>
      * @throws IllegalArgumentException if map is null
      * @since Commons Collections 3.2
      */
-    public static <K, V> SortedMap<K, V> transformedSortedMap(SortedMap<K, V> map,
+    public static <K, V> TransformedSortedMap<K, V> transformedSortedMap(SortedMap<K, V> map,
             Transformer<? super K, ? extends K> keyTransformer,
             Transformer<? super V, ? extends V> valueTransformer) {
         TransformedSortedMap<K, V> decorated = new TransformedSortedMap<K, V>(map, keyTransformer, valueTransformer);