Java中的retainAll方法详解|极客教程

Java中的retainAll方法详解

在Java中，retainAll() 方法是用于保留一个集合中与另一个集合相同的元素的方法。这个方法主要用于集合的交集操作，能够方便我们快速得到两个集合中共同的元素。本文将详细讲解retainAll()方法的用法、原理和示例。

retainAll方法的基本用法

retainAll() 方法是在Collection接口中定义的一个方法，它的作用是将调用该方法的集合与另一个集合进行比较，保留两个集合中共同的元素，然后在原集合中仅保留这些共同元素。

retainAll()方法的基本语法如下：

boolean retainAll(Collection<?> c)

其中，参数c是另一个集合。该方法返回一个boolean值，表示调用该方法的集合是否发生了改变。如果原集合发生了改变，则返回true，否则返回false。

下面是一个简单的示例演示了retainAll()方法的基本用法：

import java.util.ArrayList;

public class RetainAllExample {

    public static void main(String[] args) {
        ArrayList<Integer> list1 = new ArrayList<>();
        list1.add(1);
        list1.add(2);
        list1.add(3);

        ArrayList<Integer> list2 = new ArrayList<>();
        list2.add(2);
        list2.add(3);
        list2.add(4);

        System.out.println("原始集合1：" + list1);
        System.out.println("原始集合2：" + list2);

        boolean changed = list1.retainAll(list2);

        System.out.println("保留共同元素后的集合1：" + list1);
        System.out.println("retainAll操作是否改变了集合1：" + changed);
    }
}

运行结果如下：

原始集合1：[1, 2, 3]
原始集合2：[2, 3, 4]
保留共同元素后的集合1：[2, 3]
retainAll操作是否改变了集合1：true

在上面的示例中，我们首先创建了两个ArrayList对象list1和list2，然后使用retainAll()方法将list1中与list2共同的元素保留下来，最终输出了操作后的list1集合。

retainAll方法的原理解析

retainAll() 方法的原理其实很简单，它主要是通过遍历调用该方法的集合，然后检查每个元素是否存在于传入的另一个集合中，如果不存在于另一个集合中，则将该元素从调用该方法的集合中移除。

具体实现上，retainAll()方法会调用集合的contains()方法来判断元素是否存在于另一个集合中，然后再调用集合的remove()方法来移除元素。因此，在保留共同元素的过程中，元素的顺序可能会发生变化。

retainAll方法的注意事项

在使用retainAll()方法时，需要注意以下几点：

元素类型要一致：两个集合在进行比较时，元素的类型要一致，否则在比较过程中可能会出现ClassCastException异常。
集合中有null元素：如果集合中有null元素，retainAll()方法仍然会将null元素与另一个集合中的元素进行比较，保留共同的null元素。
集合修改异常：在使用retainAll()方法时，如果调用该方法的集合被修改了，则会抛出ConcurrentModificationException异常。

retainAll方法的示例应用

retainAll()方法通常用于求两个集合的交集。下面是一个示例，演示了如何使用retainAll()方法求两个集合的交集：

import java.util.ArrayList;

public class IntersectionExample {

    public static void main(String[] args) {
        ArrayList<String> list1 = new ArrayList<>();
        list1.add("apple");
        list1.add("banana");
        list1.add("orange");

        ArrayList<String> list2 = new ArrayList<>();
        list2.add("banana");
        list2.add("orange");
        list2.add("grape");

        System.out.println("集合1：" + list1);
        System.out.println("集合2：" + list2);

        boolean changed = list1.retainAll(list2);

        System.out.println("集合1和集合2的交集：" + list1);
        System.out.println("retainAll操作是否改变了集合1：" + changed);
    }
}

运行结果如下：

集合1：[apple, banana, orange]
集合2：[banana, orange, grape]
集合1和集合2的交集：[banana, orange]
retainAll操作是否改变了集合1：true

在上面的示例中，我们首先创建了两个ArrayList对象list1和list2，然后使用retainAll()方法求出了两个集合的交集，并输出了最终的交集结果。

总结

本文详细介绍了Java中的retainAll()方法，包括其基本用法、原理、注意事项和示例应用。

Java中的retainAll方法详解