Java ArrayDeque retainAll() 方法及示例

描述

java ArrayDeque retainAll(Collection<?> c) 方法保留 ArrayDeque 对象和提供的集合元素中存在的全部公共元素，并删除其他剩余元素。此方法会修改 ArrayDeque 对象。

声明

以下是 java.util.ArrayDeque.retainAll(Collection<?> c) 方法的声明

public boolean retainAll​(Collection<?> c)

参数

c − 包含要从此集合中保留的元素的集合。

返回值

如果此 ArrayDeque 因调用而发生更改，则返回 true。

异常

NullPointerException − 如果此 ArrayDeque 包含一个或多个 null 元素，并且指定的集合不支持 null 元素，或者如果指定的集合为 null。

示例 #1

以下示例演示了使用带整数的 Java ArrayDeque retainAll() 方法。我们创建了一个整数的 ArrayDeque，添加了一些元素，打印它，然后使用 retainAll() 方法保留一些元素。由于 ArrayDeque 已被修改，因此打印它以检查是否保留了指定的元素。

package com.tutorialspoint;

import java.util.ArrayDeque;
import java.util.Arrays;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<Integer> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add(25);
      deque.add(30);
      deque.add(20);
      deque.add(18);        

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will retain two common elements
      System.out.println("ArrayDeque modified:  " + deque.retainAll(Arrays.asList(11,30,20,12)));
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}

让我们编译并运行上述程序，这将产生以下结果：

ArrayDeque = [25, 30, 20, 18]
ArrayDeque modified:  true
ArrayDeque = [30, 20]

示例 #2

以下示例演示了使用带字符串的 Java ArrayDeque retainAll() 方法。我们创建了一个字符串的 ArrayDeque，添加了一些元素，打印它，然后使用 retainAll() 方法保留一些元素。由于 ArrayDeque 已被修改，因此打印它以检查是否保留了指定的元素。

package com.tutorialspoint;

import java.util.ArrayDeque;
import java.util.Arrays;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<String> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add("A");
      deque.add("B");
      deque.add("C");
      deque.add("D");        

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will retain two common elements
      System.out.println("ArrayDeque modified:  " + deque.retainAll(Arrays.asList("E","B","C","F")));
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}

让我们编译并运行上述程序，这将产生以下结果：

ArrayDeque = [A, B, C, D]
ArrayDeque modified:  true
ArrayDeque = [B, C]

示例 #3

以下示例演示了使用带 Student 对象的 Java ArrayDeque retainAll() 方法。我们创建了一个 Student 对象的 ArrayDeque，添加了一些元素，打印它，然后使用 retainAll() 方法保留一些学生。由于 ArrayDeque 已被修改，因此打印它以检查是否保留了指定的元素。

package com.tutorialspoint;

import java.util.ArrayDeque;
import java.util.Arrays;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<Student> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add(new Student(1, "Julie"));
      deque.add(new Student(2, "Robert"));
      deque.add(new Student(3, "Adam"));       

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will return true after retaining two students from deque
      System.out.println("Student removed : " + deque.retainAll(
         Arrays.asList(new Student(2, "Robert"),new Student(3, "Adam"))));
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}
class Student {
   int rollNo;
   String name;

   Student(int rollNo, String name){
      this.rollNo = rollNo;
      this.name = name;
   }

   @Override
   public String toString() {
      return "[ " + this.rollNo + ", " + this.name + " ]";
   }
   
   @Override
   public boolean equals(Object obj) {
      Student s = (Student)obj;
      return this.rollNo == s.rollNo && this.name.equalsIgnoreCase(s.name);
   }
}

让我们编译并运行上述程序，这将产生以下结果：

ArrayDeque = [[ 1, Julie ], [ 2, Robert ], [ 3, Adam ]]
Student removed : true
ArrayDeque = [[ 2, Robert ], [ 3, Adam ]]