Enumクラス

enumクラスの最も基本的なユースケースは、型安全な列挙型の実装です。

enum class Direction {
    NORTH, SOUTH, WEST, EAST
}

各列挙定数はオブジェクトです。列挙定数はコンマで区切られます。

各列挙型はenumクラスのインスタンスであるため、次のように初期化できます。

enum class Color(val rgb: Int) {
    RED(0xFF0000),
    GREEN(0x00FF00),
    BLUE(0x0000FF)
}

匿名クラス

列挙定数は、対応するメソッドを持つ独自の匿名クラスを宣言したり、基底メソッドをオーバーライドしたりできます。

enum class ProtocolState {
    WAITING {
        override fun signal() = TALKING
    },

    TALKING {
        override fun signal() = WAITING
    };

    abstract fun signal(): ProtocolState
}

enumクラスがメンバーを定義する場合、定数の定義とメンバーの定義はセミコロンで区切ります。

enumクラスでのインターフェースの実装

enumクラスはインターフェースを実装できます（ただし、クラスから派生することはできません）。その際、すべてのエントリに対してインターフェースメンバーの共通の実装を提供するか、各エントリの匿名クラス内で個別の実装を提供できます。これは、実装したいインターフェースを次のようにenumクラス宣言に追加することで行われます。

import java.util.function.BinaryOperator
import java.util.function.IntBinaryOperator

enum class IntArithmetics : BinaryOperator<Int>, IntBinaryOperator {
    PLUS {
        override fun apply(t: Int, u: Int): Int = t + u
    },
    TIMES {
        override fun apply(t: Int, u: Int): Int = t * u
    };
    
    override fun applyAsInt(t: Int, u: Int) = apply(t, u)
}

fun main() {
    val a = 13
    val b = 31
    for (f in IntArithmetics.entries) {
        println("$f($a, $b) = ${f.apply(a, b)}")
    }
}

すべてのenumクラスは、デフォルトでComparableインターフェースを実装します。enumクラスの定数は自然順序で定義されます。詳細については、Orderingを参照してください。

列挙定数の操作

Kotlinのenumクラスには、定義された列挙定数をリスト化したり、名前で列挙定数を取得したりするための合成プロパティとメソッドがあります。これらのメソッドのシグネチャは次のとおりです（enumクラスの名前がEnumClassであると仮定します）。

EnumClass.valueOf(value: String): EnumClass
EnumClass.entries: EnumEntries<EnumClass> // specialized List<EnumClass>

以下に、それらが実際に動作する例を示します。

enum class RGB { RED, GREEN, BLUE }

fun main() {
    for (color in RGB.entries) println(color.toString()) // prints RED, GREEN, BLUE
    println("The first color is: ${RGB.valueOf("RED")}") // prints "The first color is: RED"
}

valueOf()メソッドは、指定された名前がクラスで定義された列挙定数のいずれにも一致しない場合、IllegalArgumentExceptionをスローします。

Kotlin 1.9.0でentriesが導入される前は、values()関数が列挙定数の配列を取得するために使用されていました。

すべての列挙定数には、その名前とenumクラス宣言での位置（0から始まる）を取得するためのプロパティnameとordinalもあります。

enum class RGB { RED, GREEN, BLUE }

fun main() {
    println(RGB.RED.name)    // prints RED
    println(RGB.RED.ordinal) // prints 0
}

enumValues<T>()関数とenumValueOf<T>()関数を使用すると、enumクラスの定数にジェネリックな方法でアクセスできます。Kotlin 2.0.0では、enumValues<T>()関数の代替としてenumEntries<T>()関数が導入されました。enumEntries<T>()関数は、指定されたenum型Tのすべての列挙エントリのリストを返します。

enumValues<T>()関数はまだサポートされていますが、パフォーマンスへの影響が少ないため、代わりにenumEntries<T>()関数を使用することをお勧めします。enumValues<T>()を呼び出すたびに新しい配列が作成されるのに対し、enumEntries<T>()を呼び出すたびに毎回同じリストが返されるため、はるかに効率的です。

例:

enum class RGB { RED, GREEN, BLUE }

inline fun <reified T : Enum<T>> printAllValues() {
    println(enumEntries<T>().joinToString { it.name })
}

printAllValues<RGB>() 
// RED, GREEN, BLUE

TIP

インライン関数と実体化された型パラメータに関する詳細については、インライン関数を参照してください。