From 60a3e7c07aa7ac8102ee5b31fbdebb2c6c84f609 Mon Sep 17 00:00:00 2001 From: Thomas Neidhart Date: Tue, 3 Jul 2012 21:24:25 +0000 Subject: [PATCH] Cleanup of splitmap package. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1356955 13f79535-47bb-0310-9956-ffa450edef68 --- .../{splitmap => }/SplitMapUtils.java | 4 +- .../AbstractIterableGetMapDecorator.java | 10 ++--- .../collections/splitmap/TransformedMap.java | 18 ++++----- .../collections/splitmap/package-info.java | 39 +++++++++++++++++++ .../commons/collections/splitmap/package.html | 39 ------------------- 5 files changed, 53 insertions(+), 57 deletions(-) rename src/main/java/org/apache/commons/collections/{splitmap => }/SplitMapUtils.java (99%) create mode 100644 src/main/java/org/apache/commons/collections/splitmap/package-info.java delete mode 100644 src/main/java/org/apache/commons/collections/splitmap/package.html diff --git a/src/main/java/org/apache/commons/collections/splitmap/SplitMapUtils.java b/src/main/java/org/apache/commons/collections/SplitMapUtils.java similarity index 99% rename from src/main/java/org/apache/commons/collections/splitmap/SplitMapUtils.java rename to src/main/java/org/apache/commons/collections/SplitMapUtils.java index b34c1ce23..dffc5856d 100644 --- a/src/main/java/org/apache/commons/collections/splitmap/SplitMapUtils.java +++ b/src/main/java/org/apache/commons/collections/SplitMapUtils.java @@ -38,10 +38,10 @@ import org.apache.commons.collections.set.UnmodifiableSet; * and/or {@link Get} but not {@link Map}. * * @since Commons Collections 4.0 - * @version $Revision$ + * @version $Id$ + * * @see Get * @see Put - * @author Matt Benson */ public class SplitMapUtils { diff --git a/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java b/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java index 6157e8a28..1cf2a5f53 100644 --- a/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java +++ b/src/main/java/org/apache/commons/collections/splitmap/AbstractIterableGetMapDecorator.java @@ -20,21 +20,19 @@ import java.util.Collection; import java.util.Map; import java.util.Set; -import org.apache.commons.collections.Get; import org.apache.commons.collections.IterableGet; import org.apache.commons.collections.MapIterator; import org.apache.commons.collections.map.EntrySetToMapIteratorAdapter; /** - * {@link IterableGet} that uses a {@link Map} for the {@link Get} - * implementation. + * {@link IterableGet} that uses a {@link Map} for the + * {@link org.apache.commons.collections.Get Get} implementation. * * @since Commons Collections 4.0 - * @version $Revision$ - * - * @author Matt Benson + * @version $Id$ */ public class AbstractIterableGetMapDecorator implements IterableGet { + /** The map to decorate */ protected transient Map map; diff --git a/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java b/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java index 19d335b6d..398d6677c 100644 --- a/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java +++ b/src/main/java/org/apache/commons/collections/splitmap/TransformedMap.java @@ -27,7 +27,7 @@ import org.apache.commons.collections.Transformer; import org.apache.commons.collections.map.LinkedMap; /** - * Decorates another Map to transform objects that are added. + * Decorates another {@link Map} to transform objects that are added. *

* The Map put methods and Map.Entry setValue method are affected by this class. * Thus objects must be removed or searched for using their transformed form. @@ -53,15 +53,13 @@ import org.apache.commons.collections.map.LinkedMap; * generalizations. * * @since Commons Collections 4.0 - * @version $Revision$ + * @version $Id$ + * * @see SplitMapUtils#readableMap(Get) * @see SplitMapUtils#writableMap(Put) - * - * @author Stephen Colebourne - * @author Matt Benson */ -public class TransformedMap extends AbstractIterableGetMapDecorator implements - Put, Serializable { +public class TransformedMap extends AbstractIterableGetMapDecorator + implements Put, Serializable { /** Serialization version */ private static final long serialVersionUID = 5966875321133456994L; @@ -150,7 +148,7 @@ public class TransformedMap extends AbstractIterableGetMapDecorator< * The transformer itself may throw an exception if necessary. * * @param object the object to transform - * @throws the transformed object + * @return the transformed object */ protected K transformKey(J object) { return keyTransformer.transform(object); @@ -162,7 +160,7 @@ public class TransformedMap extends AbstractIterableGetMapDecorator< * The transformer itself may throw an exception if necessary. * * @param object the object to transform - * @throws the transformed object + * @return the transformed object */ protected V transformValue(U object) { return valueTransformer.transform(object); @@ -174,7 +172,7 @@ public class TransformedMap extends AbstractIterableGetMapDecorator< * The transformer itself may throw an exception if necessary. * * @param map the map to transform - * @throws the transformed object + * @return the transformed object */ @SuppressWarnings("unchecked") protected Map transformMap(Map map) { diff --git a/src/main/java/org/apache/commons/collections/splitmap/package-info.java b/src/main/java/org/apache/commons/collections/splitmap/package-info.java new file mode 100644 index 000000000..9392ae312 --- /dev/null +++ b/src/main/java/org/apache/commons/collections/splitmap/package-info.java @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * The "split map" concept is that of an object that implements + * the {@link org.apache.commons.collections.Put Put} and + * {@link org.apache.commons.collections.Get Get} interfaces, + * with differing generic types. This is like a pre-generics + * {@link java.util.Map Map} whose input key/value constraints are + * different than its output key/value constraints. While it would + * be possible to declare a "split map" with matching input/output + * key/value constraints, this would be a {@link java.util.Map Map} + * and would therefore make little sense (any Commons Collections + * {@link java.util.Map Map} implementation will also implement + * {@link org.apache.commons.collections.Put Put} and + * {@link org.apache.commons.collections.Get Get} with matching + * generic parameters). + *

+ * The following decorators are provided: + *

    + *
  • Transformed - transforms each element added + *
+ * + * @version $Id$ + */ +package org.apache.commons.collections.splitmap; \ No newline at end of file diff --git a/src/main/java/org/apache/commons/collections/splitmap/package.html b/src/main/java/org/apache/commons/collections/splitmap/package.html deleted file mode 100644 index 464ae43c8..000000000 --- a/src/main/java/org/apache/commons/collections/splitmap/package.html +++ /dev/null @@ -1,39 +0,0 @@ - - - -

The "split map" concept is that of an object that implements -the {@link org.apache.commons.collections.Put Put} and -{@link org.apache.commons.collections.Get Get} interfaces, -with differing generic types. This is like a pre-generics -{@link java.util.Map Map} whose input key/value constraints are -different than its output key/value constraints. While it would -be possible to declare a "split map" with matching input/output -key/value constraints, this would be a {@link java.util.Map Map} -and would therefore make little sense (any Commons Collections -{@link java.util.Map Map} implementation will also implement -{@link org.apache.commons.collections.Put Put} and -{@link org.apache.commons.collections.Get Get} with matching -generic parameters). - -

-The following decorators are provided: -

    -
  • Transformed - transforms each element added -
- -