Método SortedSet retainAll() en Java con ejemplos

El método de retención de todos() de la interfaz SortedSet se utiliza para retener de este SortedSet, todos sus elementos que están contenidos en la colección especificada.

Sintaxis:  

public boolean retainAll(Collection c)

Parámetros: este método toma la colección c como un parámetro que contiene elementos que se conservarán de este SortedSet.

Valor devuelto: este método devuelve verdadero si este SortedSet cambió como resultado de la llamada.

Excepción: este método lanza NullPointerException si este conjunto contiene un elemento nulo y la colección especificada no permite elementos nulos (opcional), o si la colección especificada es nula.

Nota : el método de retención() en SortedSet se hereda de la interfaz Set en Java.

A continuación se muestran los ejemplos para ilustrar el método de retención() .

Ejemplo 1:  

// Java program to demonstrate
// retainAll() method for Sorted set
 
import java.util.*;
 
public class GFG1 {
    public static void main(String[] args)
        throws Exception
    {
 
        try {
 
            // Creating object of Set
            SortedSet<Integer> arrset1
                = new TreeSet<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
            SortedSet<Integer> arrset2
                = new TreeSet<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(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]

Ejemplo 2: para NullPointerException .

// Java program to demonstrate
// retainAll() method for Sorted set
 
import java.util.*;
 
public class GFG1 {
    public static void main(String[] args)
        throws Exception
    {
        try {
 
            // Creating object of SortedSet<Integer>
            SortedSet<Integer> arrset1
                = new TreeSet<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>
            SortedSet<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(e);
        }
    }
}

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

Trying to pass null as a specified element

java.lang.NullPointerException

Referencia : https://docs.oracle.com/javase/7/docs/api/java/util/Set.html#retainAll(java.util.Collection)