From 37ace6950e0c63b4bfe3bb602be1fac9176ab1ba Mon Sep 17 00:00:00 2001 From: Thomas Neidhart Date: Tue, 3 Jul 2012 21:39:25 +0000 Subject: [PATCH] Cleanup of keyvalue package. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1356967 13f79535-47bb-0310-9956-ffa450edef68 --- .../keyvalue/AbstractKeyValue.java | 7 +---- .../keyvalue/AbstractMapEntry.java | 7 +---- .../keyvalue/AbstractMapEntryDecorator.java | 4 +-- .../collections/keyvalue/DefaultKeyValue.java | 7 +---- .../collections/keyvalue/DefaultMapEntry.java | 11 ++----- .../collections/keyvalue/MultiKey.java | 7 ++--- .../collections/keyvalue/TiedMapEntry.java | 4 +-- .../keyvalue/UnmodifiableMapEntry.java | 4 +-- .../collections/keyvalue/package-info.java | 30 +++++++++++++++++++ .../commons/collections/keyvalue/package.html | 30 ------------------- 10 files changed, 41 insertions(+), 70 deletions(-) create mode 100644 src/main/java/org/apache/commons/collections/keyvalue/package-info.java delete mode 100644 src/main/java/org/apache/commons/collections/keyvalue/package.html diff --git a/src/main/java/org/apache/commons/collections/keyvalue/AbstractKeyValue.java b/src/main/java/org/apache/commons/collections/keyvalue/AbstractKeyValue.java index 26c17ad2a..baf0d4a72 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/AbstractKeyValue.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/AbstractKeyValue.java @@ -23,12 +23,7 @@ import org.apache.commons.collections.KeyValue; * and {@link java.util.Map.Entry Map.Entry} implementations. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author James Strachan - * @author Michael A. Smith - * @author Neil O'Toole - * @author Stephen Colebourne + * @version $Id$ */ public abstract class AbstractKeyValue implements KeyValue { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java b/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java index ed92e5b42..87133794c 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java @@ -23,12 +23,7 @@ import java.util.Map; * {@link java.util.Map.Entry Map.Entry} implementations. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author James Strachan - * @author Michael A. Smith - * @author Neil O'Toole - * @author Stephen Colebourne + * @version $Id$ */ public abstract class AbstractMapEntry extends AbstractKeyValue implements Map.Entry { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntryDecorator.java b/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntryDecorator.java index 54d87690f..34aab85f3 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntryDecorator.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/AbstractMapEntryDecorator.java @@ -25,9 +25,7 @@ import org.apache.commons.collections.KeyValue; * added to a {@link java.util.Map.Entry Map.Entry}. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public abstract class AbstractMapEntryDecorator implements Map.Entry, KeyValue { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java b/src/main/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java index ac767e5c5..b6afcb2b2 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java @@ -28,12 +28,7 @@ import org.apache.commons.collections.KeyValue; * itself as a key or value. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author James Strachan - * @author Michael A. Smith - * @author Neil O'Toole - * @author Stephen Colebourne + * @version $Id$ */ public class DefaultKeyValue extends AbstractKeyValue { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/DefaultMapEntry.java b/src/main/java/org/apache/commons/collections/keyvalue/DefaultMapEntry.java index 0d79e8a18..e6b488fe8 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/DefaultMapEntry.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/DefaultMapEntry.java @@ -21,16 +21,11 @@ import java.util.Map; import org.apache.commons.collections.KeyValue; /** - * A restricted implementation of {@link java.util.Map.Entry} that prevents - * the Map.Entry contract from being broken. + * A restricted implementation of {@link Map.Entry} that prevents + * the {@link Map.Entry} contract from being broken. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author James Strachan - * @author Michael A. Smith - * @author Neil O'Toole - * @author Stephen Colebourne + * @version $Id$ */ public final class DefaultMapEntry extends AbstractMapEntry { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/MultiKey.java b/src/main/java/org/apache/commons/collections/keyvalue/MultiKey.java index 670031dea..f20ddf7e8 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/MultiKey.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/MultiKey.java @@ -40,10 +40,7 @@ import java.util.Arrays; * * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Howard Lewis Ship - * @author Stephen Colebourne + * @version $Id$ */ public class MultiKey implements Serializable { // This class could implement List, but that would confuse it's purpose @@ -258,7 +255,7 @@ public class MultiKey implements Serializable { /** * Calculate the hash code of the instance using the provided keys. - * @param keys + * @param keys the keys to calculate the hash code for */ private void calculateHashCode(Object[] keys) { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java b/src/main/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java index 4ed4f830a..6b0cff0f9 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java @@ -28,9 +28,7 @@ import org.apache.commons.collections.KeyValue; * map, however this will probably mess up any iterators. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public class TiedMapEntry implements Map.Entry, KeyValue, Serializable { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/UnmodifiableMapEntry.java b/src/main/java/org/apache/commons/collections/keyvalue/UnmodifiableMapEntry.java index 0a4d66ca7..dcf532a54 100644 --- a/src/main/java/org/apache/commons/collections/keyvalue/UnmodifiableMapEntry.java +++ b/src/main/java/org/apache/commons/collections/keyvalue/UnmodifiableMapEntry.java @@ -26,9 +26,7 @@ import org.apache.commons.collections.Unmodifiable; * UnsupportedOperationException when setValue is called. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public final class UnmodifiableMapEntry extends AbstractMapEntry implements Unmodifiable { diff --git a/src/main/java/org/apache/commons/collections/keyvalue/package-info.java b/src/main/java/org/apache/commons/collections/keyvalue/package-info.java new file mode 100644 index 000000000..7b877b6cc --- /dev/null +++ b/src/main/java/org/apache/commons/collections/keyvalue/package-info.java @@ -0,0 +1,30 @@ +/* + * 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. + */ +/** + * This package contains implementations of collection and map related key/value classes. + * These are usually used in maps, however they can be used as data holders in any collection. + *

+ * The following key/value designs are included: + *

    + *
  • Map Entry - various map entry implementations + *
  • KeyValue - a key and value pair, without map entry semantics + *
  • MultiKey - a holder of multiple keys tied together + *
+ * + * @version $Id$ + */ +package org.apache.commons.collections.keyvalue; diff --git a/src/main/java/org/apache/commons/collections/keyvalue/package.html b/src/main/java/org/apache/commons/collections/keyvalue/package.html deleted file mode 100644 index 9ebde443a..000000000 --- a/src/main/java/org/apache/commons/collections/keyvalue/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - -

-This package contains implementations of collection and map related key/value classes. -These are usually used in maps, however they can be used as data holders in any collection. -

-The following key/value designs are included: -

    -
  • Map Entry - various map entry implementations -
  • KeyValue - a key and value pair, without map entry semantics -
  • MultiKey - a holder of multiple keys tied together -
- -