1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen// GenericsNote: Converted. 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/* 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2004 The Apache Software Foundation 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Licensed under the Apache License, Version 2.0 (the "License"); 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smack.util.collections; 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Map; 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Abstract Pair class to assist with creating correct Map Entry implementations. 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author James Strachan 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Michael A. Smith 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Neil O'Toole 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Matt Hall, John Watkinson, Stephen Colebourne 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @version $Revision: 1.1 $ $Date: 2005/10/11 17:05:32 $ 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @since Commons Collections 3.0 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic abstract class AbstractMapEntry <K,V> extends AbstractKeyValue<K, V> implements Map.Entry<K, V> { 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Constructs a new entry with the given key and given value. 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param key the key for the entry, may be null 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param value the value for the entry, may be null 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected AbstractMapEntry(K key, V value) { 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen super(key, value); 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Map.Entry interface 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen //------------------------------------------------------------------------- 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the value stored in this Map Entry. 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <p/> 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * This Map Entry is not connected to a Map, so only the local data is changed. 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param value the new value 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the previous value 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public V setValue(V value) { 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen V answer = this.value; 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.value = value; 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return answer; 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Compares this Map Entry with another Map Entry. 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <p/> 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Implemented per API documentation of {@link java.util.Map.Entry#equals(Object)} 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param obj the object to compare to 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return true if equal key and value 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public boolean equals(Object obj) { 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (obj == this) { 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return true; 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (obj instanceof Map.Entry == false) { 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return false; 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen Map.Entry other = (Map.Entry) obj; 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return (getKey() == null ? other.getKey() == null : getKey().equals(other.getKey())) && (getValue() == null ? other.getValue() == null : getValue().equals(other.getValue())); 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Gets a hashCode compatible with the equals method. 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <p/> 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Implemented per API documentation of {@link java.util.Map.Entry#hashCode()} 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return a suitable hash code 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public int hashCode() { 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return (getKey() == null ? 0 : getKey().hashCode()) ^ (getValue() == null ? 0 : getValue().hashCode()); 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 90