Javaでコレクションを読み取り専用にする方法｜unmodifiable系メソッドの使い方

Collectionsクラスとは

java.utilパッケージのCollectionsクラスは、コレクション専用に動作するユーティリティメソッドを多数提供しており、多相的アルゴリズム（polymorphic algorithms）を含むさまざまな追加操作を行うことができます。

このクラスには、既存のコレクションを変更不可能（読み取り専用）なビューとして返すunmodifiableXXX()メソッド群が用意されています。主なバリアントは以下の通りです。

対象となるコレクションの種類に応じて、これらのメソッドのいずれかを呼び出すだけで、コレクションオブジェクトを読み取り専用にできます。

サンプルプログラム

次のJavaプログラムでは、Vectorオブジェクトを生成して要素を追加し、それを読み取り専用のコレクションに変換しています。

import java.util.Collection;
import java.util.Collections;
import java.util.Vector;

public class CollectionReadOnly {
    public static void main(String[] args) {
        // Vectorオブジェクトの生成
        Vector<String> vector = new Vector<String>();
        vector.add("JavaFx");
        vector.add("Java");
        vector.add("WebGL");
        vector.add("OpenCV");
        System.out.println(vector);

        Collection<String> immutableVector = Collections.unmodifiableCollection(vector);
        System.out.println("Vector converted to read only " + immutableVector);

        immutableVector.add("CoffeeScript"); // 変更しようとすると例外が発生
    }
}

実行結果と例外

[JavaFx, Java, WebGL, OpenCV]
Vector converted to read only [JavaFx, Java, WebGL, OpenCV]
Exception in thread "main" java.lang.UnsupportedOperationException
    at java.util.Collections$UnmodifiableCollection.add(Unknown Source)
    at September19.CollectionReadOnly.main(CollectionReadOnly.java:20)

注意点

一度読み取り専用のビューを取得すると、その内容を変更することはできません。つまり、add()やremove()による要素の追加・削除はもちろん、Iterator経由での変更も許されません。これらの操作を実行しようとすると、UnsupportedOperationExceptionがスローされます。

また、元のコレクション自体への参照を保持している場合は、そちらから内容を変更できてしまう点にも注意が必要です。完全な不変性（イミュータブル性）が必要なケースでは、Java 9以降で利用可能なList.of()、Set.of()、Map.of()といったファクトリメソッドや、GuavaのImmutableコレクションの活用も検討するとよいでしょう。