集計行を追記できる一覧と、集計行を含めて完成した変更不可の一覧を比べる記事のアイキャッチ

実装・エラー解決

JavaのStream.toList()にaddできない理由|変更できるListの作り方

注文一覧で表示対象を絞った後、末尾に合計行を足します。明細は正しく作れたのに、rows.add(...) で UnsupportedOperationException が出て、画面を開けません。調べると、明細のListを作る最後の処理は Stream.toList() でした。

収集後に行を足したい場合は、Collectors.toCollection(ArrayList::new) で変更できるListを作ります。合計まで含めた結果を返すだけなら、明細と合計行を Stream.concat で結合してから toList() にできます。

この記事でわかること

  • Stream.toList() の結果に add できない理由
  • 後から編集する一覧と、合計まで含めて完成させる一覧の作り分け
  • どちらも元の注文Listを変えずに作れたことを確かめるテスト

記事と同じコードを実行する

ZIPを展開し、JDK 17とMaven 3.9系で mvn test を実行します。注文一覧を作るJava本体、旧コードの例外と2つの修正を確認するJUnit、pom.xml、READMEを収録しています。

サンプルZIPをダウンロード GitHubでコード全文と実行手順を見る

filterは通っても、toListの結果にaddした時点で例外になる

注文の入力はA-101(1,200円)、A-102(5,000円)、A-103(800円)の3件です。A-102は表示対象外なので、画面にはA-101とA-103だけを出し、合計2,000円を末尾に足します。旧コードは filter と map で二つの明細を作り、toList() の後で合計行 TOTAL を加えます。

例外を再現する呼び出し(テストの抜粋)

List<DisplayRow> rows = ORDERS.stream()
        .filter(Order::visible)
        .map(order -> new DisplayRow(order.number(), order.amountYen()))
        .toList();
rows.add(TOTAL);

コンパイルが通るのは、変数の型である List に add が宣言されているためです。実行時にその操作ができるかは、どこから受け取ったListかで決まります。Java 16で追加された Stream.toList() は変更不可のListを返すと仕様で定められています。filter で何件に絞ったかにかかわらず、Listへ add するところで例外になります。Java 17のStream.toListの仕様で、返すListの契約を確認できます。

同じ例外でも、Arrays.asList から受け取ったListなら固定長の配列ビューを調べます。この例はStreamの収集結果なので、まず最後に呼んだメソッドを見ます。

関連記事JavaのArrays.asListにaddできない原因|List.of・ArrayListとの違い 配列からListを作った場合は、固定長のArrays.asListと、変更可能なArrayListの違いを確認できます。 記事を読む

合計をどの時点で加え、その後も編集するかを決める

画面の組み立て中に「備考」などの表示行も足すなら、編集できるListを返す必要があります。明細と合計がそろえば画面が読むだけなら、収集前にすべての行をそろえ、完成したListを返せます。どちらの結果にもA-101、A-103、合計2,000円があり、入力にはA-102を含む注文3件が残ります。

同じ2明細と合計を、いつそろえるか
注文3件 → 表示する明細2行A-101 1,200円 + A-103 800円
収集後も編集するtoCollection(ArrayList::new)明細2行のListへ合計をadd明細2行 + 合計2,000円完成後も行を足せる
合計を含めて返すconcat(...).toList()明細と合計をつないで収集明細2行 + 合計2,000円完成後は行を足せない

収集後に編集するなら、toCollectionでArrayListを作る

収集後に編集する場合(本体の抜粋)

public static List<DisplayRow> editableRows(List<Order> orders) {
    List<DisplayRow> rows = visibleRows(orders).collect(Collectors.toCollection(ArrayList::new));
    rows.add(totalRow(rows));
    return rows;
}

Collectors.toCollection(ArrayList::new) は、指定した方法で新しい ArrayList を作り、明細を格納します。そこへ合計行を1件追加します。戻したListには、呼び出し側から備考行も追加できます。Collectors.toCollectionのAPIで、コレクションの作り方を指定できると確認できます。

collect(Collectors.toList()) にすると環境によっては追加できても、仕様は返すListが変更可能であることを保証していません。追加を前提にするなら、ArrayList を作る契約をコードに書きます。Collectors.toListのAPIに、返るListの型や変更可能性は保証しないと記載されています。

完成した一覧を返すなら、concatで合計をつないでからtoListする

合計を含めて完成させる場合(本体の抜粋)

public static List<DisplayRow> completedRows(List<Order> orders) {
    List<DisplayRow> details = visibleRows(orders).toList();
    return Stream.concat(details.stream(), Stream.of(totalRow(details))).toList();
}

先に表示対象の明細を details にそろえます。合計はその明細から計算するので、非表示のA-102は金額に入りません。Stream.concat(details.stream(), Stream.of(totalRow(details))) で、明細の後ろに合計1行をつなぎ、最後に toList() で受け取ります。完成後にListへ add する行はありません。

変更不可という契約はListの追加・削除・置換に対するものです。要素に変更可能なオブジェクトが入っていれば、その中身まで凍結されるわけではありません。この例では元の注文と別に DisplayRow を作り、行のラベルと金額を持たせています。

OrderDisplay.java(全文)
package info.syachiku.orders;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public final class OrderDisplay {
    private OrderDisplay() {
    }

    public static List<DisplayRow> editableRows(List<Order> orders) {
        List<DisplayRow> rows = visibleRows(orders).collect(Collectors.toCollection(ArrayList::new));
        rows.add(totalRow(rows));
        return rows;
    }

    public static List<DisplayRow> completedRows(List<Order> orders) {
        List<DisplayRow> details = visibleRows(orders).toList();
        return Stream.concat(details.stream(), Stream.of(totalRow(details))).toList();
    }

    private static Stream<DisplayRow> visibleRows(List<Order> orders) {
        return orders.stream()
                .filter(Order::visible)
                .map(order -> new DisplayRow(order.number(), order.amountYen()));
    }

    private static DisplayRow totalRow(List<DisplayRow> details) {
        long totalYen = details.stream().mapToLong(DisplayRow::amountYen).sum();
        return new DisplayRow("合計", totalYen);
    }

    public record Order(String number, long amountYen, boolean visible) {
    }

    public record DisplayRow(String label, long amountYen) {
    }
}

JUnitで合計行、追記の可否、元の注文3件を確認する

ZIPを展開し、pom.xml のある場所で mvn test を実行します。JDK 17、Maven 3.9系、JUnit Jupiter 5.12.2、Surefire 3.5.3の例です。旧コードの追記は assertThrows で例外を確かめます。修正版のテストは明細と合計の内容まで比較し、単に例外が出なくなったかだけで判断しません。

編集用のListへ備考行を追加して4行になること、完成用のListへ同じ行を足すと例外になることを確認します。入力を変更できる ArrayList として渡すケースも用意し、修正版を両方呼んだ後で元の注文3件が同じ並び・同じ値で残ることを確かめます。表示対象が0件のときは、両方とも合計0円だけを返します。

OrderDisplayTest.java(全文)
package info.syachiku.orders;

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

import info.syachiku.orders.OrderDisplay.DisplayRow;
import info.syachiku.orders.OrderDisplay.Order;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

class OrderDisplayTest {
    private static final Order FIRST = new Order("A-101", 1_200, true);
    private static final Order HIDDEN = new Order("A-102", 5_000, false);
    private static final Order LAST = new Order("A-103", 800, true);
    private static final List<Order> ORDERS = List.of(FIRST, HIDDEN, LAST);
    private static final DisplayRow TOTAL = new DisplayRow("合計", 2_000);
    private static final DisplayRow NOTE = new DisplayRow("備考", 0);
    private static final List<DisplayRow> EXPECTED = List.of(
            new DisplayRow("A-101", 1_200),
            new DisplayRow("A-103", 800),
            TOTAL);

    @Test
    void addingToStreamToListThrows() {
        List<DisplayRow> rows = ORDERS.stream()
                .filter(Order::visible)
                .map(order -> new DisplayRow(order.number(), order.amountYen()))
                .toList();

        assertThrows(UnsupportedOperationException.class, () -> rows.add(TOTAL));
    }

    @Test
    void editableListContainsSummary() {
        assertEquals(EXPECTED, OrderDisplay.editableRows(ORDERS));
    }

    @Test
    void editableListCanBeEditedAfterBuilding() {
        var rows = OrderDisplay.editableRows(ORDERS);
        rows.add(NOTE);

        assertEquals(4, rows.size());
        assertEquals(NOTE, rows.get(3));
    }

    @Test
    void completedListContainsSummaryAndRejectsAppend() {
        var rows = OrderDisplay.completedRows(ORDERS);

        assertEquals(EXPECTED, rows);
        assertThrows(UnsupportedOperationException.class, () -> rows.add(NOTE));
    }

    @Test
    void bothChoicesLeaveTheSourceListUntouched() {
        var original = new ArrayList<>(ORDERS);
        var edited = OrderDisplay.editableRows(original);
        var completed = OrderDisplay.completedRows(original);
        edited.add(NOTE);

        assertEquals(ORDERS, original);
        assertEquals(EXPECTED, completed);
    }

    @Test
    void zeroVisibleOrdersProducesZeroTotal() {
        var zero = List.of(new DisplayRow("合計", 0));

        assertEquals(zero, OrderDisplay.editableRows(List.of(HIDDEN)));
        assertEquals(zero, OrderDisplay.completedRows(List.of(HIDDEN)));
    }
}
pom.xml(全文)
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>info.syachiku</groupId>
  <artifactId>stream-tolist-mutable-sample</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>5.12.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.3.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.14.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.5.3</version>
      </plugin>
    </plugins>
  </build>
</project>

修正版は6件成功します。別の展開先で editableRows の収集を toList() に戻すと、合計を足す行で4件がエラーになります。もう一つの展開先で completedRows を return details; に変えると、追加の例外は起きませんが、合計が足りず3件が失敗します。試したら変更を戻します。

通常実行と二つの変更のログ抜粋

修正版の mvn test
[INFO] Tests run: 6, Failures: 0, Errors: 0, Skipped: 0

編集用の収集をtoListに戻した版の mvn test
java.lang.UnsupportedOperationException
	at info.syachiku.orders.OrderDisplay.editableRows(OrderDisplay.java:14)
[ERROR] Tests run: 6, Failures: 0, Errors: 4, Skipped: 0

完成用から合計を外した版の mvn test
[ERROR] Tests run: 6, Failures: 3, Errors: 0, Skipped: 0

レビューでは、Listを作った場所と変更する場所を確認する

レビューコメント例「ここは Stream.toList() で返したListに合計を追加するため、実行時に失敗します。呼び出し元で備考も足すなら変更できるArrayListを作り、合計だけで完成なら concat で行をそろえてから収集しましょう。表示の都合で入力の注文Listを変更していないことも確認してください。」

画面で並べ替えや追記をする担当が別のクラスにあるなら、そのクラスが受け取るListを変更できるかもAPIの約束にします。元のListに変更が反映されるかは、別途ビューとコピーを区別して判断します。

提出前に、合計行と元の一覧を別々に確認する

  • 例外が出たListを作ったメソッドと、実際に変更した行を確認した。
  • 後で編集する一覧か、完成した一覧かを決めた。
  • 表示対象外の注文を合計に含めず、合計行が1件だけ末尾にある。
  • 元の注文3件の値と並びが変わらず、表示対象0件の結果も確認した。

List と ArrayList の違いを基本から確かめたい場合は、『スッキリわかるJava入門 第5版』の第16章「コレクション」が参考になります。変数の型がListでも、実際に作ったコレクションがどの操作を引き受けるかを整理する土台になります。

書籍「スッキリわかるJava入門 第5版」の表紙
商品画像:Amazon.co.jp
PR Java初学者向け

スッキリわかるJava入門 第5版

中山 清喬 (著), 国本 大悟 (著), 株式会社フレアリンク (監修)

変数・条件分岐から、クラスの基本まで学ぶ一冊。

豊富な図とサンプルで、変数、条件分岐、クラス、例外処理まで順番に学べます。Javaの最初の教科書を探している人向けです。

  • Javaを基礎から体系的に学びたい
  • Java 25 LTS対応の入門書を選びたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

関連記事JavaのCollections.unmodifiableListで元のList変更が反映される理由|List.copyOfとの違い 元のListを後で変更した場合に、ビューとコピーへどこまで反映されるかを比較できます。 記事を読む 関連記事Java初心者におすすめの最初の1冊|Spring Bootに進むまでの学び方 型や条件分岐を読むところから学び直したいときに、Javaの最初の1冊と進み方を選べます。 記事を読む

まとめ

Streamの結果にあとから行を足すなら、toCollection(ArrayList::new) で編集可能なListを作ります。完成した一覧を返すなら、必要な行を concat でそろえてから toList() を使います。合計と、入力の注文Listがそのまま残ることまでテストします。

-実装・エラー解決
-, ,