Java 21 の EnumSet が SequencedSet インタフェースを実装していない理由

2024-07-27

一見すると、EnumSet は SequencedSet インタフェースを実装するのに理想的な候補のように思えます。しかし、いくつかの理由により、これは行われていません。

理由 1: EnumSet は要素の順序を保証しない

EnumSet は要素の順序を 保証しません。これは、EnumSet が内部的に BitSet を使用して実装されているためです。BitSet はビット配列を使用して要素を表現し、ビット配列の順序は実装によって定義されます。

理由 2: EnumSet の順序を変更する方法は存在しない

EnumSet には、要素の順序を変更するメソッドは存在しません。add() メソッドは要素を追加しますが、その要素がセット内のどこに挿入されるかは保証されません。

理由 3: SequencedSet インタフェースは複雑な機能を提供する

SequencedSet インタフェースは、subSet() や headSet() などの複雑な機能を提供します。これらの機能は、EnumSet の内部実装と互換性がありません。

代替案

EnumSet で要素の順序を保持したい場合は、次のような代替案があります。

LinkedHashSet を使用する
EnumSet を List に変換してからソートする
カスタム実装を作成する

import java.util.EnumSet;
import java.util.LinkedHashSet;

public class EnumSetExample {

    public static void main(String[] args) {
        // EnumSet を作成
        EnumSet<Season> seasons = EnumSet.allOf(Season.class);

        // LinkedHashSet に変換
        LinkedHashSet<Season> sortedSeasons = new LinkedHashSet<>(seasons);

        // 順序を出力
        for (Season season : sortedSeasons) {
            System.out.println(season);
        }
    }

    public enum Season {
        SPRING,
        SUMMER,
        AUTUMN,
        WINTER
    }
}

他の方法

import java.util.EnumSet;
import java.util.List;
import java.util.Collections;

public class EnumSetExample {

    public static void main(String[] args) {
        // EnumSet を作成
        EnumSet<Season> seasons = EnumSet.allOf(Season.class);

        // List に変換
        List<Season> sortedSeasons = new ArrayList<>(seasons);

        // ソート
        Collections.sort(sortedSeasons);

        // 順序を出力
        for (Season season : sortedSeasons) {
            System.out.println(season);
        }
    }

    public enum Season {
        SPRING,
        SUMMER,
        AUTUMN,
        WINTER
    }
}

独自の SortedEnumSet クラスを作成することもできます。このクラスは EnumSet を拡張し、要素の順序を保持する機能を追加する必要があります。

public class SortedEnumSet<E extends Enum<E>> extends EnumSet<E> {

    private List<E> sortedElements;

    public SortedEnumSet(Class<E> elementType) {
        super(elementType);
        sortedElements = new ArrayList<>();
    }

    @Override
    public boolean add(E element) {
        boolean added = super.add(element);
        if (added) {
            sortedElements.add(element);
        }
        return added;
    }

    public List<E> sortedElements() {
        return Collections.unmodifiableList(sortedElements);
    }
}