PR: COLLECTIONS-332 Documented the dependency of ListOrderedMap on the standard Map contract of using equals() and hashCode().
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/branches/COLLECTIONS_3_2_BRANCH@1079578 13f79535-47bb-0310-9956-ffa450edef68 Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/1c23c026 Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/1c23c026 Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/1c23c026 Branch: refs/heads/COLLECTIONS_3_2_BRANCH Commit: 1c23c026ff3d37408364c9e4a735ea2970b96770 Parents: a5f5ec9 Author: Jochen Wiedmann <joc...@apache.org> Authored: Tue Mar 8 22:21:32 2011 +0000 Committer: Jochen Wiedmann <joc...@apache.org> Committed: Tue Mar 8 22:21:32 2011 +0000 ---------------------------------------------------------------------- .../apache/commons/collections/map/ListOrderedMap.java | 10 ---------- 1 file changed, 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1c23c026/src/java/org/apache/commons/collections/map/ListOrderedMap.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/commons/collections/map/ListOrderedMap.java b/src/java/org/apache/commons/collections/map/ListOrderedMap.java index 09d3262..8b76e16 100644 --- a/src/java/org/apache/commons/collections/map/ListOrderedMap.java +++ b/src/java/org/apache/commons/collections/map/ListOrderedMap.java @@ -59,16 +59,6 @@ import org.apache.commons.collections.list.UnmodifiableList; * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw * exceptions when accessed by concurrent threads without synchronization. * <p> - * <strong>Note that ListOrderedMap doesn't work with {@link IdentityMap}, - * {@link CaseInsensitiveMap}, or similar maps that violate the general - * contract of {@link java.util.Map}.</strong> The <code>ListOrderedMap</code> - * (or, more precisely, the underlying <code>List</code>) is relying on - * {@link Object#java.lang.equals(Object) equals()}. This is fine, as long as the - * decorated <code>Map</code> is also based on {@link Object#equals(Object) equals()}, - * and {@link Object#hashCode() hashCode()}, which {@link IdentityMap}, and - * {@link CaseInsensitiveMap} don't: The former uses <code>==</code>, and - * the latter uses {@link Object#equals(Object) equals()} on a lowercased - * key. * <p> * This class is Serializable from Commons Collections 3.1. *