【Java】ArrayListから指定した値を検索して最初に出現するインデックスを返すArrayList.indexOfメソッドについて解説します

Java

2023.03.31

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

この記事では、 JavaでArrayListから指定した値を検索して最初に出現するインデックスを返すArrayList.indexOfメソッドについて

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

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

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

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

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

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

ArrayList.indexOfメソッドとは、呼び出したArrayListからから引数で指定されている値を検索して最初に出現するインデックスを返すメソッドです。
見つからなかった場合は、「-1」を返します。
ArrayList.indexOfメソッドを使うためには、

import java.util.ArrayList;

1	import java.util.ArrayList;

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

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

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

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

sample.add("hogehoge");

sample.add("test");

sample.add("hogehoge");

int result = sample.indexOf("hogehoge");

上記のサンプルだと変数resultには「0」が返されます。
では、次の章で実際に使ってみます。

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

ArrayList.indexOfメソッドを解説するプログラムでは、検索する値が

存在する場合
存在しない場合

の2パターンでそれぞれArrayList.indexOfメソッドを使って要素数を確認します。

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

Javaサンプルプログラム

package sample;

import java.util.ArrayList;

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

        System.out.println("・存在する場合");
        int appleIndex = fruitList.indexOf("リンゴ");
        System.out.println("リンゴが最初に表れるインデックス：" + appleIndex);

        System.out.println("・存在しない場合");
        int strawberryIndex = fruitList.indexOf("イチゴ");
        System.out.println("イチゴが最初に表れるインデックス：" + strawberryIndex);

    }
}

package sample;

import java.util.ArrayList;

public class Sample {

public static void main(String[] args) {

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

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

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

fruitList.add("みかん");

fruitList.add("リンゴ");

fruitList.add("メロン");

fruitList.add("リンゴ");

System.out.println("・存在する場合");

int appleIndex = fruitList.indexOf("リンゴ");

System.out.println("リンゴが最初に表れるインデックス：" + appleIndex);

System.out.println("・存在しない場合");

int strawberryIndex = fruitList.indexOf("イチゴ");

System.out.println("イチゴが最初に表れるインデックス：" + strawberryIndex);

}

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

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

実行結果

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

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

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

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

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

■ArrayList.indexOfメソッドサンプルプログラム
・存在する場合
リンゴが最初に表れるインデックス：2
・存在しない場合
イチゴが最初に表れるインデックス：-1

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

・存在する場合

リンゴが最初に表れるインデックス：2

・存在しない場合

イチゴが最初に表れるインデックス：-1

指定した値が存在する場合は最初に現れるインデックス、存在しない場合は「-1」が返されていることが確認できました。

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

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

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