Java List.retainAll()方法的详解

1. 引言

在Java编程中，List是一个非常常用的数据结构，它代表了一组有序的元素，可以进行随机访问和遍历操作。List接口继承自Collection接口，并提供了更丰富的操作方法。其中，List.retainAll()方法在某些情况下非常有用，本文将详细介绍这个方法的用法和使用技巧。

2. List.retainAll()方法的定义

List.retainAll()方法用于保留List中包含在指定集合中的所有元素，也就是将List中的元素与指定集合进行比较，只保留两者共有的部分。该方法的定义如下：

boolean retainAll(Collection<?> c)

在上述定义中，参数c表示要进行比较的集合，返回值为一个布尔类型的值，表示是否成功保留了List中的元素。

3. 示例代码解释

下面我们通过一些示例代码来详细说明List.retainAll()方法的用法。

示例1：基本用法

import java.util.ArrayList;
import java.util.List;

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

        List<Integer> list2 = new ArrayList<>();
        list2.add(3);
        list2.add(4);
        list2.add(5);
        list2.add(6);
        list2.add(7);

        boolean result = list1.retainAll(list2);

        System.out.println("List1: " + list1);
        System.out.println("List2: " + list2);
        System.out.println("Result: " + result);
    }
}

输出结果：

List1: [3, 4, 5]
List2: [3, 4, 5, 6, 7]
Result: true

在上述示例中，我们创建了两个整数类型的List：list1和list2。list1包含了1到5的整数，list2包含了3到7的整数。然后，我们调用了list1.retainAll(list2)方法，保留了list1中与list2共有的元素。最后，我们输出了结果并观察到结果为true，说明保留操作成功。

示例2：与非基本数据类型一起使用

import java.util.ArrayList;
import java.util.List;

class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

public class ListExample {
    public static void main(String[] args) {
        List<Person> list1 = new ArrayList<>();
        list1.add(new Person("Alice", 20));
        list1.add(new Person("Bob", 25));
        list1.add(new Person("Charlie", 30));

        List<Person> list2 = new ArrayList<>();
        list2.add(new Person("Bob", 25));
        list2.add(new Person("Charlie", 30));
        list2.add(new Person("David", 40));
        list2.add(new Person("Eve", 35));

        boolean result = list1.retainAll(list2);

        System.out.println("List1: " + list1);
        System.out.println("List2: " + list2);
        System.out.println("Result: " + result);
    }
}

输出结果：

List1: [Person{name='Bob', age=25}, Person{name='Charlie', age=30}]
List2: [Person{name='Bob', age=25}, Person{name='Charlie', age=30}, Person{name='David', age=40}, Person{name='Eve', age=35}]
Result: true

在上述示例中，我们创建了两个存储Person对象的List：list1和list2。list1包含了三个Person对象，list2包含了四个Person对象。然后，我们调用了list1.retainAll(list2)方法，保留了list1中与list2共有的对象。最后，我们输出了结果，并打印出了被保留的Person对象。