HashMap的put方法返回值問題

API文檔中的描述：

 

先看一個例子

Map<Character, Integer> map = new HashMap<Character, Integer>();
System.out.println(map.put('a', 0)); // null
System.out.println(map.put('a', 1)); // 0
System.out.println(map.put('a', 2)); // 1
System.out.println(map.put('b', 1)); // null
System.out.println(map.put('b', 2)); // 1
System.out.println(map.get('a')); //2

 

可以看出：put方法的返回值為null或value；

調用put方法時，如果已經存在一個相同的key， 則返回的是前一個key對應的value，同時該key的新value覆蓋舊value；
如果是新的一個key，則返回的是null；

通過hashmap的源碼可以看出：

map中一個映射不能包含重復的鍵。每個鍵最多只能映射一個值。即相同的key在Map中只會有一個與之關聯的value存在。
put()方法實現：首先使用hash(key)得到key的hashcode()，hashmap根據獲得的hashcode找到要插入的位置所在的鏈，在這個鏈里面放的都是hashcode相同的Entry鍵值對，
在找到這個鏈之后，會通過equals()方法判斷是否已經存在要插入的鍵值對，而這個equals比較的就是key。
添加對應的key-value這樣的鍵值對node時，如果原本已經存在相同的key，則直接改變對應的value，並返回舊的value；如果不存在相同的key，則插入，在插入鏈表時，如果鏈表長度為臨界長度TREEIFY_THRESHOLD，再插入任何元素就要變成紅黑樹。

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);//put方法調用putVal方法
    }

    /**
     * Implements Map.put and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
     * @param evict if false, the table is in creation mode.
     * @return previous value, or null if none
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key  //key已經存在
                V oldValue = e.value; //將已經存在的結點e的value值賦給oldValue
                if (!onlyIfAbsent || oldValue == null)//當onlyIfAbsent為false或者oldValue為null時，進行覆蓋操作
                    e.value = value;//覆蓋原結點的value值，用新值替換舊值
                afterNodeAccess(e);
                return oldValue;//返回的是被覆蓋的oldValue
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

 

在hashset中的add方法調用的就是hashmap的put方法，判斷put方法的返回值是否等於空，來保證hashset的值不重復。

private transient HashMap<E,Object> map;

/**
     * Adds the specified element to this set if it is not already present.
     * More formally, adds the specified element <tt>e</tt> to this set if
     * this set contains no element <tt>e2</tt> such that
     * <tt>(e==null&nbsp;?&nbsp;e2==null&nbsp;:&nbsp;e.equals(e2))</tt>.
     * If this set already contains the element, the call leaves the set
     * unchanged and returns <tt>false</tt>.
     *
     * @param e element to be added to this set
     * @return <tt>true</tt> if this set did not already contain the specified
     * element
     */
    public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }