S-JIS[2014-07-05/2023-09-24] 変更履歴

java.util.List

Javaのコレクションのひとつであるリストについて。

概要

リストは、末尾に要素を追加してゆき、先頭から順番に全要素を処理するのに適したコレクション。
同じ値（要素）を複数保持することも出来る。
リストでは要素の並び順が保証される。

→Setは値（要素）は1種類ずつしか保持できず、並び順も（基本的には）不定 。その代わり、存在有無のチェック（containsメソッド）は得意。

リストはjava.util.Listインターフェースで表される。
具象クラスとしては、java.util.ArrayListが使われることが多い。
保持する要素の型（クラス）はジェネリクスで指定するので、以下のようにして使う。

import java.util.List;
import java.util.ArrayList;

		List<String>  slist = new ArrayList<>(10); // 要素がStringのリスト
		List<Integer> ilist = new ArrayList<>(10); // 要素がIntegerのリスト

具象クラスの種類に関わらず、変数の型はListにすることが多い。
これは、その変数を「リストとして扱いたい」という意図であり、具象クラスの種類は（とりあえず）何でもいいから。
実際、Arrays.asList()の戻り値やUnmodifiableListを受け取ることもあるので、インターフェースで宣言しておく方が都合が良い。

Listの上にはCollectionというインターフェースもあるのだが、これはSetと共通なので、リストとして扱いたい場合はやはりListインターフェースを指定するのが妥当だろう。

ListはIterableインターフェースを継承しているので、for each構文で使うことが出来る。
→順次アクセス処理

リストの具象クラス

Listの主な具象クラス。

リストの初期化

配列だと初期値を列挙する初期化構文がある（Scalaのリスト（Seq）にも初期値を指定する方法がある）が、JavaのListでは構文としては用意されていない。
初期値を設定したリストを作るには以下のような方法が考えられる。

“インデックスを使ったアクセスメソッドしか存在しないクラス”から、その一覧（リスト）を作成する例。

	// Excelのシート一覧を作成する（POI）
	Workbook workbook = WorkbookFactory.create(new File(excelFile));
	List<Sheet> sheets = IntStream.range(0, workbook.getNumberOfSheets()).mapToObj(i -> workbook.getSheetAt(i)).collect(Collectors.toList());

IntStream.rangeメソッドに開始インデックス（0）と終了インデックス（要素の個数）を指定し、インデックスのStreamを作成する。
後は、mapToObjメソッドで、インデックスを使ったアクセスメソッドを呼び出し、欲しいオブジェクトを取得する。

空リスト

空のリストを使いたい場合は、Collections.emptyListを使うのが便利。[2010-05-29]

import java.util.Collections;

	List<String> list = Collections.emptyList();

ただし、このemptyListは不変リストなので、要素を追加することは出来ない。

リストのメソッド

List関連の主なメソッド。

クラスやメソッドによっては、java.lang.UnsupportedOperationExceptionを返す実装もある。
例えばUnmodifiableListは不変リストなので、値を変更するaddやsetメソッドを呼び出すとUnsupportedOperationExceptionが発生する。

順次アクセス操作

リストでは、保持している値（要素）を先頭から順番に処理していくことがある。

for (Iterator i = list.iterator(); i.hasNext();) {
	型 変数 = (型) i.next();
〜
}

for (Iterator<型> i = list.iterator(); i.hasNext();) {
	型 変数 = i.next();
〜
}

for (型 変数 : list) {
〜
}

list.forEach(変数 -> {
〜
});

RandomAccessインターフェースを実装しているリストであっても、for each構文の場合は（内部では）Iteratorパターンになってしまうが、
forEachメソッドは具象クラスごとに効率の良い実装になっているので、forEachメソッドを使う方が良さそう。

変換処理

リストの全要素を別の型に変換して新しいリストを作成する例。

List slist = Arrays.asList(new Object[]{ "a.txt", "b.txt", "c.txt"} );
List flist = new ArrayList(slist.size());
for (Iterator i = slist.iterator(); i.hasNext();) {
	String s = (String) i.next();
	flist.add(new File(s));
}

List<String> slist = Arrays.asList("a.txt", "b.txt", "c.txt");
List<File> flist = new ArrayList<File>(slist.size());
for (String s : slist) {
	flist.add(new File(s));
}

List<String> slist = Arrays.asList("a.txt", "b.txt", "c.txt");
List<File> flist = slist.stream().map(s -> new File(s)).collect(Collectors.toList());

削除処理

特定条件の要素を削除する例。

List<String> slist = new ArrayList<String>(Arrays.asList("a", "bb", "ccc"));
for (Iterator<String> i = slist.iterator(); i.hasNext();) {
	String s = i.next();
	if (s.length() == 2) {
		i.remove();
	}
}

List<String> slist = new ArrayList<>(Arrays.asList("a", "bb", "ccc"));
slist.removeIf(s -> s.length() == 2);

重複排除処理

リスト内の重複した要素を1つにまとめる例。

public static List<String> distinct(List<String> slist) {
	List<String> dlist = new ArrayList<String>();

	Set<String> set = new HashSet<String>();
	for (String s : slist) {
		if (!set.contains(s)) {
			set.add(s);
			dlist.add(s);
		}
	}

	return dlist;
}

public static void distinct(List<String> slist) {
	Set<String> set = new HashSet<String>();
	for (Iterator<String> i = slist.iterator(); i.hasNext();) {
		String s = i.next();
		if (set.contains(s)) {
			i.remove();
		} else {
			set.add(s);
		}
	}
}

public static List<String> distinct(List<String> slist) {
	return new ArrayList<String>(new LinkedHashSet<String>(slist));
}

public static Collection<String> distinct(List<String> slist) {
	return new LinkedHashSet<String>(slist);
}

public static List<String> distinct(List<String> slist) {
	return slist.stream().distinct().collect(Collectors.toList());
}

ランダムアクセス操作

ArrayList（やVector）は、RandomAccessインターフェースを実装している。[2007-03-26]
これは、「順次アクセス操作（Iteratorを使って先頭から順番にアクセスする）よりも、ランダムアクセス操作（インデックスを使って途中の要素を直接指定する）の方が高速（であると想定される）」ということを意味する。
（RandomAccessを実装していないリストの代表は、LinkedList）

リストの本来の姿では、全要素を順番に操作するにはIteratorパターンを使う。
しかしRandomAccessインターフェースを実装しているコレクションでは、インデックスで直接指定する方が実行速度が速い。
と言ってもそんなに大差ない（Iteratorインスタンスの生成分と、ループ1回につきメソッド呼び出しが1〜2回分増える程度）。

for (int i = 0; i < list.size(); i++) {
	型 要素 = (型) list.get(i);
〜
}

for (int i = 0; i < list.size(); i++) {
	型 要素 = list.get(i);
〜
}

（ArrayListの場合、インデックスを使う方がIteratorパターンより3倍くらい速い）
→ArrayListとLinkedListの順次アクセス時間

ただしfor each構文ではRandomAccessまでは判断してくれず、ArrayListであってもIteratorで展開されてしまう。[2007-06-11]

forEachメソッドは（RandomAccessインターフェースとは無関係に）具象クラスごとに個別の実装になっている。[2014-07-05]

配列との変換

リストから配列を生成するにはtoArrayメソッドを使用する。[2007-12-07]

	List<String> list = new ArrayList<String>();
	list.add("abc");
	list.add("def");

	String[] array = list.toArray(new String[list.size()]);

Java9より前では、配列からリスト（サイズ不変ArrayList）を生成するにはArrays.asListメソッドを使うのが便利。

	String[] array = { "abc", "def" };
	List<String> list = Arrays.asList(array);

asListメソッドはJDK1.5で可変長引数に置き換えられたので、以下のような書き方も可。

	List<String> list = Arrays.asList("abc", "def");

ただし、asList()が返すのはサイズが変えられないリストなので注意。[2008-08-11/2010-03-06]
（つまり、add()したりremove()したり出来ない。set()すると元の配列の値も書き換わる。要するにこのリストは配列のラッパー）

Java9以降では、Arrays.asListよりList.ofの方が良いと思う。[2010-05-29]
（Listを取得するならListのクラスのメソッドを使うべき。また、List.ofの戻り値は不変リストである）

	List<String> list = List.of("abc", "def");

リストと配列のどちらを使うべきか？

リストと配列は、どちらも値（要素）を順番に保持することが出来るので、似ている。
では、メソッドの引数や戻り値の型としてリストと配列のどちらを使うべきか？というと、今はリストを使えばいいと思う。

JDK1.4以前ではジェネリクスが無かった為、リストの要素の種類（型）は何だか分からなかった。
その点、配列は要素の種類（型）が明示されるので、ソースを見たときにすぐ分かるし、異なる型を扱おうとしたらコンパイルエラーになるし、配列を使う利点があった。
JDK1.5以降ではリストに型引数（要素の種類（型））が指定できるようになったので、配列だけに有利な点は無くなった。
むしろ、全般的にリストの方が有利である。
（配列を使う必要があるのは、可変長引数くらいなのではなかろうか）

public List<String> getResults() {
  List<String> result = new ArrayList<>();
  result.add("a");
  result.add("b");
  return result;
}

public String[] getResults() {
  String[] result = { "a", "b" };
  return result;
}

List<String> result = getResults();
result.add("z");

String[] result0 = getResults();
String[] result = Arrays.copyOf(result0, result0.length + 1);
result[result0.length] = "z";

private static final List<String> RESULTS;
static {
  List<String> list = new ArrayList<>();
  list.add("a");
  list.add("b");
  RESULTS = Collections.unmodifiableList(list);
}

public List<String> getResults() {
  return RESULTS;
}

private static final String[] RESULTS = { "a", "b" };

public String[] getResults() {
  return Arrays.copyOf(RESULTS, RESULTS.length);
}

Streamとの変換

リストからStreamを生成するにはstreamもしくはparallelStreamメソッドを使用する。

	List<String> list = new ArrayList<>();
	list.add("abc");
	list.add("def");

	Stream<String> stream = list.stream();

Streamからリストを生成するにはCollectors.toListを使用する。

	Stream<String> stream = Stream.of("abc", "def");

	List<String> list = stream.collect(Collectors.toList());

Collectors.toListの内部は、java.util.ArrayListを作成して、Stream内の要素をaddしていく形になっている。