【Java】ArrayListに指定の要素を含むかを確認できるArrayList.containsメソッドについて解説します

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

この記事では、 JavaでArrayListに指定の要素を含むかを確認できるArrayList.containsメソッドについて

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

と、この記事で丁寧に解説していきます。

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

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

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

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.containsメソッドとは

ArrayList.containsメソッドとは、呼び出したArrayListに引数で指定した要素を含んでいるかを検索して結果をbooleanで返すメソッドです。
含んでいる場合はtrue、そうでない場合はfalseを返します。
ArrayList.containsメソッドを使うためには、

import java.util.ArrayList;

1	import java.util.ArrayList;

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

使い方サンプルは以下です。

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

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

sample.add("hogehoge");

sample.add("test");

boolean result = sample.contains("hogehoge");

変数resultに

true

true

が返されます。

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

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

ArrayList.containsメソッドを解説するプログラムでは、同じArrayListに対して

含まれている場合
含まれていない場合

でそれぞれArrayList.containsメソッドを使って、結果を表示させます。

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

Javaサンプルプログラム

package sample;

import java.util.ArrayList;

public class Sample {
    public static void main(String[] args) {
        System.out.println("■ArrayList.containsメソッドサンプルプログラム");
        ArrayList<String> fruitList = new ArrayList<>();
        fruitList.add("オレンジ");
        fruitList.add("みかん");
        fruitList.add("リンゴ");
        fruitList.add("メロン");
        System.out.println("確認する配列：" + fruitList);

        System.out.println("・含まれている場合");
        String apple = "リンゴ";
        if (fruitList.contains(apple)) {
            System.out.println(fruitList + "に" + apple + "は含まれています");
        } else {
            System.out.println(fruitList + "に" + apple + "は含まれていません");
        }

        System.out.println("・含まれていない場合");
        String banana = "バナナ";
        if (fruitList.contains(banana)) {
            System.out.println(fruitList + "に" + banana + "は含まれています");
        } else {
            System.out.println(fruitList + "に" + banana + "は含まれていません");
        }
    }
}

package sample;

import java.util.ArrayList;

public class Sample {

public static void main(String[] args) {

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

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

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

fruitList.add("みかん");

fruitList.add("リンゴ");

fruitList.add("メロン");

System.out.println("確認する配列：" + fruitList);

System.out.println("・含まれている場合");

String apple = "リンゴ";

if (fruitList.contains(apple)) {

System.out.println(fruitList + "に" + apple + "は含まれています");

} else {

System.out.println(fruitList + "に" + apple + "は含まれていません");

}

System.out.println("・含まれていない場合");

String banana = "バナナ";

if (fruitList.contains(banana)) {

System.out.println(fruitList + "に" + banana + "は含まれています");

} else {

System.out.println(fruitList + "に" + banana + "は含まれていません");

}

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

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

実行結果

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

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

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

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

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

■ArrayList.containsメソッドサンプルプログラム
確認する配列：[オレンジ, みかん, リンゴ, メロン]
・含まれている場合
[オレンジ, みかん, リンゴ, メロン]にリンゴは含まれています
・含まれていない場合
[オレンジ, みかん, リンゴ, メロン]にバナナは含まれていません

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

確認する配列：[オレンジ, みかん, リンゴ, メロン]

・含まれている場合

[オレンジ, みかん, リンゴ, メロン]にリンゴは含まれています

・含まれていない場合

[オレンジ, みかん, リンゴ, メロン]にバナナは含まれていません

要素が含まれているかどうかで返す値が異なることが確認できました。

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

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

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