Java - ArrayList.retainAll() 사용 방법 및 예제

javacollectionsarraylist

ArrayList의 retainAll(Collection)는 List에서 인자로 전달받은 Collection 객체가 갖고 있는 요소들을 제외한 나머지를 삭제합니다. 교집합이라고 생각하면 이해하기 쉬울까요?

public boolean retainAll(Collection<?> c)

아래 코드로 예를 들면, listA에서 listA와 listB의 공통 요소들만 남기고 나머지는 제거합니다. 즉, listA의 요소가 listB에 없으면 listA에서 제거합니다.

listA.retainAll(listB);

1. ArrayList.retainAll()의 기본 예제

아래 코드는 retainAll()의 기본 동작을 알 수 있는 예제입니다.

list1.retainAll(list2)는 list1에서 list2의 공통 요소만 남기고 나머지는 제거합니다. 즉, list1의 요소가 list2에 없으면 list1에서 제거합니다.

import java.util.ArrayList;

public class ArrayListRetainAll {

    public static void main(String[] args) {

        ArrayList<String> list1 = new ArrayList<>();
        list1.add("apple");
        list1.add("grape");
        list1.add("banana");
        list1.add("kiwi");

        ArrayList<String> list2 = new ArrayList<>();
        list2.add("apple");
        list2.add("kiwi");
        list2.add("melon");

        list1.retainAll(list2);

        System.out.println("list1: " + list1);
        System.out.println("list2: " + list2);
    }
}

Output:

list1: [apple, kiwi]
list2: [apple, kiwi, melon]

위 결과를 보시면 list1은 retainAll() 수행 후 객체의 데이터가 변경될 수 있지만, list2는 원본 데이터를 유지합니다.

2. retainAll()에 HashSet을 인자로 전달하는 예제

retainAll()은 인자로 Collection 객체를 받습니다. HashSet도 Collection을 상속하는 클래스이기 때문에 retainAll()과 함께 사용할 수 있습니다.

import java.util.ArrayList;
import java.util.HashSet;

public class ArrayListRetainAll3 {

    public static void main(String[] args) {

        ArrayList<String> list1 = new ArrayList<>();
        list1.add("apple");
        list1.add("banana");
        list1.add("kiwi");

        HashSet<String> set1 = new HashSet<>();
        set1.add("apple");
        set1.add("kiwi");

        list1.retainAll(set1);

        System.out.println("list1: " + list1);
        System.out.println("set1: " + set1);
    }
}

Output:

list1: [apple, kiwi]
set1: [apple, kiwi]

3. Exception handling

만약 인자로 전달되는 Collection 객체가 null이라면 NullPointerException가 발생합니다. null을 인자로 전달하지 않거나 NullPointerException에 대한 예외 처리를 해야 합니다.

import java.util.ArrayList;

public class ArrayListRetainAll4 {

    public static void main(String[] args) {

        ArrayList<String> list1 = new ArrayList<>();
        list1.add("apple");
        list1.add("grape");
        list1.add("banana");
        list1.add("kiwi");

        ArrayList<String> list2 = null;

        list1.retainAll(list2);

        System.out.println("list1: " + list1);
        System.out.println("list2: " + list2);
    }
}

Output:

Exception in thread "main" java.lang.NullPointerException
	at java.base/java.util.Objects.requireNonNull(Objects.java:208)
	at java.base/java.util.ArrayList.batchRemove(ArrayList.java:816)
	at java.base/java.util.ArrayList.retainAll(ArrayList.java:811)
	at ArrayListRetainAll4.main(ArrayListRetainAll4.java:15)

4. 중복 요소 처리 방식

아래 코드에서 list1과 list2에는 apple이 공통 요소입니다. 그런데 list1에는 apple이라는 요소가 두개나 있습니다. 이 때, list1.retainAll(list2) 수행 시, list1의 apple 요소는 1개만 남을 지 궁금할 수도 있는데요. 공통 요소는 리스트에서 제거를 하지 않도록 구현되었기 때문에 모든 요소들이 남아있게 됩니다.

import java.util.ArrayList;

public class ArrayListRetainAll2 {

    public static void main(String[] args) {

        ArrayList<String> list1 = new ArrayList<>();
        list1.add("apple");
        list1.add("apple");
        list1.add("banana");
        list1.add("kiwi");

        ArrayList<String> list2 = new ArrayList<>();
        list2.add("apple");
        list2.add("kiwi");

        list1.retainAll(list2);

        System.out.println("list1: " + list1);
        System.out.println("list2: " + list2);
    }
}

Output:

list1: [apple, apple, kiwi]
list2: [apple, kiwi]
Loading script...

Related Posts

codechachaCopyright ©2019 codechacha