Java Set retainAll()方法及示例

java.util.Set 接口的 retainAll() 方法用于保留该集合中包含在指定集合中的所有元素。

语法

public boolean retainAll(Collection c)

参数： 该方法以集合c为参数，包含要从这个集合中保留的元素。

返回值: 如果这个集合因调用而改变，该方法返回true。

异常： 如果这个集合包含一个空元素，而指定的集合不允许空元素（可选），或者指定的集合是空的，这个方法会抛出 NullPointerException 。

下面是一些例子来说明 retainAll() 方法。

例1 :

// Java program to demonstrate
// retainAll() method for Integer value
  
import java.util.*;
  
public class GFG1 {
    public static void main(String[] argv) throws Exception
    {
        try {
  
            // Creating object of Set
            Set<Integer> arrset1 = new HashSet<Integer>();
  
            // Populating arrset1
            arrset1.add(1);
            arrset1.add(2);
            arrset1.add(3);
            arrset1.add(4);
            arrset1.add(5);
  
            // print arrset1
            System.out.println("Set before retainAll() operation : "
                               + arrset1);
  
            // Creating another object of  Set
            Set<Integer> arrset2 = new HashSet<Integer>();
            arrset2.add(1);
            arrset2.add(2);
            arrset2.add(3);
  
            // print arrset2
            System.out.println("Collection Elements to be retained : "
                               + arrset2);
  
            // Removing elements from arrset
            // specified in arrset2
            // using retainAll() method
            arrset1.retainAll(arrset2);
  
            // print arrset1
            System.out.println("Set after retainAll() operation : "
                               + arrset1);
        }
  
        catch (NullPointerException e) {
            System.out.println("Exception thrown : " + e);
        }
    }
}

输出:

Set before retainAll() operation : [1, 2, 3, 4, 5]
Collection Elements to be retained : [1, 2, 3]
Set after retainAll() operation : [1, 2, 3]

例2： 对于NullPointerException .

// Java program to demonstrate
// retainAll() method for Integer value
  
import java.util.*;
  
public class GFG1 {
    public static void main(String[] argv) throws Exception
    {
        try {
  
            // Creating object of Set<Integer>
            Set<Integer> arrset1 = new HashSet<Integer>();
  
            // Populating arrset1
            arrset1.add(1);
            arrset1.add(2);
            arrset1.add(3);
            arrset1.add(4);
            arrset1.add(5);
  
            // print arrset1
            System.out.println("Set before retainAll() operation : "
                               + arrset1);
  
            // Creating another object of Set<Integer>
            Set<Integer> arrset2 = null;
  
            // print arrset2
            System.out.println("Collection Elements to be retained : "
                               + arrset2);
  
            System.out.println("\nTrying to pass "
                               + "null as a specified element\n");
  
            // Removing elements from arrset
            // specified in arrset2
            // using retainAll() method
            arrset1.retainAll(arrset2);
  
            // print arrset1
            System.out.println("Set after retainAll() operation : "
                               + arrset1);
        }
  
        catch (NullPointerException e) {
            System.out.println("Exception thrown : " + e);
        }
    }
}

输出:

Set before retainAll() operation : [1, 2, 3, 4, 5]
Collection Elements to be retained : null

Trying to pass null as a specified element

Exception thrown : java.lang.NullPointerException

参考资料 : https://docs.oracle.com/javase/7/docs/api/java/util/Set.html#retainAll(java.util.Collection)