HashMap.put의 return 객체는 무엇일까?

private Map<String, String> map = new HashMap<String, String>();
 
public boolean isPut(String text) {
    return map.put("test", text) != null;
}

  isPut 메소드와 같은(map에 데이터를 put하고 데이터가 잘 저장되었는지 확인하는 메소드) 메소드를 만든다고 가정해보자.

  정상적으로 동작할까? HashMap에 put 메소드는 새롭게 저장된 데이터 즉, 새로운 key로 저장된 데이터라고 판단되면 null을 반환한다. 그러니까 위 코드는 한번 호출 됐다면 false를 return할 것이고, 두번 이상 호출 됐다면 true를 return할 것이다. 의도와 다른 메소드이다.

그렇다면 List는 어떨까?

private List<String> list = new ArrayList<String>();
 
public boolean isAdd(String text) {
    return list.add(text);
}

  ArrayList 클래스에 add 메소드는 return type 자체가 boolean이다. 정상적으로 add되었다면 true를 return한다.

그럼 실제 put과 add 메소드를 살펴보자.

HashMap.put

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    HashMap.Node<K,V>[] tab; HashMap.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 {
        HashMap.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 HashMap.TreeNode)
            e = ((HashMap.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
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

  HashMap에 put 메소드를 호출하게되면 실제로 데이터를 저장하는 메소드인 putVal 메소드이다. 29번 라인을 보면 주석으로 알 수 있듯이 동일한 key로 입력되었을때 기존 데이터를 return한다.

중요한 부분이다. 아래 표를 참고하자.

호출 횟수	key	value	return value
1	test	woniper	null
2	test	kyungwon	woniper
3	test	lee	kyungwon

ArrayList.add

public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}

배열에 데이터를 저장한 후 무조건 true를 return하는 것을 볼 수 있다.

왜 이렇게 헷갈리게 메소드를 만들어놨을까 생각을 해보았는데, 같은 Collection API지만 자료구조 자체가 다르기 때문에 그렇다고 생각된다. 이런 메소드를 만들땐 잘 구분하고 생각해서 사용해야겠다.