【Java】ArrayListの指定した要素をすべて削除するArrayList.removeAllメソッドについて解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、12年目エンジニアです。

この記事では、 JavaでArrayListの指定した要素をすべて削除するArrayList.removeAllメソッドについて

ArrayList.removeAllメソッドとは
ArrayList.removeAllメソッドを使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
ArrayList.removeAllメソッドとは
ArrayList.removeAllメソッドを解説するプログラムの概要
Javaサンプルプログラム
実行結果
まとめ：ArrayList.removeAllメソッドを使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
IntelliJ IDEAのエディション	Community(無料版)
IntelliJ IDEAのバージョン	2021.3.2
プロジェクト	Javaプロジェクト
SDK	Oracle OpenJDK version17.0.2

Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。

【IntelliJ IDEA】インストールするやり方を解説します（Windows向け）

ArrayList.removeAllメソッドとは

ArrayList.removeAllメソッドとは、ArrayListから引数で指定されているコレクション内のすべての要素を削除して結果をbooleanで返すメソッドです。
removeAllメソッド実行でArrayListが変更した場合はtrue、変わらなかった場合はfalseが返されます。

ArrayList.removeAllメソッドを使うためには、

import java.util.ArrayList;

1	import java.util.ArrayList;

をインポートする必要があります。

たとえば

ArrayList<String> sample = new ArrayList<>();
sample.add("test");
sample.add("hogehoge");
sample.add("test");

ArrayList<String> sample = new ArrayList<>();

sample.add("test");

sample.add("hogehoge");

sample.add("test");

というArrayListがある、とします。
中身は

test
hogehoge
test

test

hogehoge

test

です。

このArrayListに対して

ArrayList<String> remove = new ArrayList<>();
remove.add("test");
boolean result = sample.removeAll(remove);

ArrayList<String> remove = new ArrayList<>();

remove.add("test");

boolean result = sample.removeAll(remove);

と実行した場合、変数sampleは

hogehoge

hogehoge

というArrayListになり、変数resultには

true

true

が返されます。

では、次の章で実際に使ってみます。

ArrayList.removeAllメソッドを解説するプログラムの概要

ArrayList.removeAllメソッドを解説するプログラムでは、ArrayListを新規作成しremoveAllメソッドを実行します。
実行前後でArrayList、返り値を表示させて確認します。

解説で使うJavaプログラムは、Sampleプロジェクトのsampleパッケージ内にある、とします。
JavaのArrayList.removeAllメソッドを解説

Javaサンプルプログラム

package sample;

import java.util.ArrayList;

public class Sample {
    public static void main(String[] args) {
        System.out.println("■ArrayList.removeAllメソッドサンプルプログラム");
        ArrayList<String> fruitList = new ArrayList<>();
        fruitList.add("リンゴ");
        fruitList.add("オレンジ");
        fruitList.add("ぶどう");
        fruitList.add("リンゴ");
        fruitList.add("いちご");

        System.out.println("削除実行前：" + fruitList);

        ArrayList<String> removeFruitList = new ArrayList<>();
        removeFruitList.add("リンゴ");
        removeFruitList.add("オレンジ");
        System.out.println("削除対象：" + removeFruitList);

        boolean result = fruitList.removeAll(removeFruitList);
        System.out.println("削除実行後：" + fruitList);
        System.out.println("返り値：" + result);
    }
}

package sample;

import java.util.ArrayList;

public class Sample {

public static void main(String[] args) {

System.out.println("■ArrayList.removeAllメソッドサンプルプログラム");

ArrayList<String> fruitList = new ArrayList<>();

fruitList.add("リンゴ");

fruitList.add("オレンジ");

fruitList.add("ぶどう");

fruitList.add("リンゴ");

fruitList.add("いちご");

System.out.println("削除実行前：" + fruitList);

ArrayList<String> removeFruitList = new ArrayList<>();

removeFruitList.add("リンゴ");

removeFruitList.add("オレンジ");

System.out.println("削除対象：" + removeFruitList);

boolean result = fruitList.removeAll(removeFruitList);

System.out.println("削除実行後：" + fruitList);

System.out.println("返り値：" + result);

}

ArrayList.addメソッドは、ArrayListに引数で指定されている値を追加するメソッドです。
詳しくはこちらの記事をご参考ください。

【Java】ArrayListに要素を追加するArrayList.addメソッドについて解説します

実行結果

Javaプログラムを実行します。
実行のやり方は

プログラムを右クリックして実行
実行タブから実行
ガターから実行

の3種類あるので、いずれかで実行します。
詳しい解説は以下の記事をご参考ください。

【IntelliJ IDEA】引数なしでJavaアプリケーションを実行するやり方を解説します

JavaのArrayList.removeAllメソッドを解説

■ArrayList.removeAllメソッドサンプルプログラム
削除実行前：[リンゴ, オレンジ, ぶどう, リンゴ, いちご]
削除対象：[リンゴ, オレンジ]
削除実行後：[ぶどう, いちご]
返り値：true

■ArrayList.removeAllメソッドサンプルプログラム

削除実行前：[リンゴ, オレンジ, ぶどう, リンゴ, いちご]

削除対象：[リンゴ, オレンジ]

削除実行後：[ぶどう, いちご]

返り値：true

ArrayListから指定したものがすべて削除されていることが確認できました。

まとめ：ArrayList.removeAllメソッドを使ってみよう！

以上がJavaのArrayList.removeAllメソッドについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ