Java ArrayList retainAll() - Retain Specified Elements

Introduction

The retainAll() method in Java's ArrayList class is a powerful tool for filtering list items based on specified conditions. It modifies the original ArrayList by retaining only the elements that are also present in a specified collection, removing all other elements that do not meet the condition. This method is particularly useful when needing to extract a subset of elements that fulfill specific criteria from a larger group.

In this article, you will learn how to effectively use the retainAll() method across various practical scenarios. Explore how this method helps in narrowing down lists to meet required conditions, with examples that demonstrate its application in different contexts.

Understanding the retainAll() Method

Basic Usage of retainAll()

1. Create two ArrayList instances, one containing the main list and the other containing elements to retain.

2. Call the retainAll() method on the main list, passing the second list as an argument.

   JAVA

   Copy

   ArrayList<String> mainList = new ArrayList<>(Arrays.asList("Apple", "Banana", "Cherry", "Date"));
   ArrayList<String> retainList = new ArrayList<>(Arrays.asList("Banana", "Date"));
   
   mainList.retainAll(retainList);
   System.out.println(mainList);

   Explain Code

   Powered by Vultr AgentBeta

   This code retains only "Banana" and "Date" in mainList because these elements are also present in retainList. The other elements are removed.

Managing Lists with Custom Objects

1. Define a custom class with proper equals() and hashCode() implementations to ensure correct behavior of retainAll().

2. Create ArrayList instances of this custom class and use retainAll() on them.

   JAVA

   Copy

   class Fruit {
       String name;
       int price;
   
       Fruit(String name, int price) {
           this.name = name;
           this.price = price;
       }
   
       @Override
       public boolean equals(Object obj) {
           if (this == obj) return true;
           if (obj == null || getClass() != obj.getClass()) return false;
           Fruit fruit = (Fruit) obj;
           return name.equals(fruit.name);
       }
   
       @Override
       public int hashCode() {
           return Objects.hash(name);
       }
   }
   
   ArrayList<Fruit> fruits = new ArrayList<>();
   fruits.add(new Fruit("Apple", 100));
   fruits.add(new Fruit("Banana", 30));
   
   ArrayList<Fruit> retainFruits = new ArrayList<>();
   retainFruits.add(new Fruit("Banana", 60));
   
   fruits.retainAll(retainFruits);
   System.out.println(fruits.size());  // Output: 1

   Explain Code

   Powered by Vultr AgentBeta

   This example uses a custom Fruit class. retainAll() checks the equality based on the name field only, retaining the "Banana" object in fruits even though the prices differ.

Conclusion

The retainAll() function in Java ArrayList allows for effective filtering of lists based on specified conditions, significantly modifying the list to retain only desirable elements. Whether dealing with simple data types or custom objects, ensure relevant equality checks are in place to achieve the desired behavior. Use the retainAll() method across various scenarios to refine your lists efficiently, leaving them with only the relevant data needed for further processing or analysis.