【Java】ArrayListから指定したインデックスの要素を置換するArrayList.setメソッドについて解説します

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

この記事では、 JavaでArrayListから指定したインデックスの要素を置換するArrayList.setメソッドについて

ArrayList.setメソッドとは
ArrayList.setメソッドを使うときの注意点
ArrayList.setメソッドを使ったサンプルプログラム

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

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

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

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

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

ArrayList.setメソッドとは、呼び出したArrayListを引数で指定されているインデックスの要素を指定した値に置換し、置換する前の要素を返すメソッドです。
ArrayList.setメソッドを使うためには、

import java.util.ArrayList;

1	import java.util.ArrayList;

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

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

ArrayList<String> sample = new ArrayList<>();
sample.add("hogehoge");
sample.add("test");
String result = sample.set(0, "sample");

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

sample.add("hogehoge");

sample.add("test");

String result = sample.set(0, "sample");

上記のサンプルだと変数resultには

hogehoge

hogehoge

という文字列が返され、変数sampleは

[sample, test]

1	[sample, test]

という中身のArrayListになっています。

ArrayList.setメソッドを使うときの注意点

ArrayList.setメソッドを使うときの注意点として、引数には呼び出したArrayListの要素数以内の数しか指定できない、があります。
たとえば

ArrayList<String> sample = new ArrayList<>();
sample.add("hogehoge");
sample.add("test");
String result = sample.set(10, "sample");

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

sample.add("hogehoge");

sample.add("test");

String result = sample.set(10, "sample");

と要素数より大きい数をArrayList.setメソッドに指定して実行すると

Exception in thread "main" java.lang.IndexOutOfBoundsException

1	Exception in thread "main" java.lang.IndexOutOfBoundsException

という例外が発生します。
負の数でも同様な例外が発生します。

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

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

ArrayList.setメソッドを解説するプログラムでは、ArrayListを生成してArrayList.setメソッドで要素を置換します。
実行前後でArrayListと置換した要素を画面に表示させて置換できているかを確認します。

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

Javaサンプルプログラム

package sample;

import java.util.ArrayList;

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

        String setFruit = fruitList.set(2, "バナナ");
        System.out.println("・実行後");
        System.out.println(fruitList);
        System.out.println("置換した要素：" + setFruit);
    }
}

package sample;

import java.util.ArrayList;

public class Sample {

public static void main(String[] args) {

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

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

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

fruitList.add("みかん");

fruitList.add("リンゴ");

fruitList.add("メロン");

System.out.println("・実行前");

System.out.println(fruitList);

String setFruit = fruitList.set(2, "バナナ");

System.out.println("・実行後");

System.out.println(fruitList);

System.out.println("置換した要素：" + setFruit);

}

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

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

実行結果

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

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

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

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

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

■ArrayList.setメソッドサンプルプログラム
・実行前
[オレンジ, みかん, リンゴ, メロン]
・実行後
[オレンジ, みかん, バナナ, メロン]
置換した要素：リンゴ

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

・実行前

[オレンジ, みかん, リンゴ, メロン]

・実行後

[オレンジ, みかん, バナナ, メロン]

置換した要素：リンゴ

指定したインデックスの要素が置換できていることが確認できました。

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

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

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