列舉類別

列舉類別最基本的用例是實作型別安全的列舉：

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

每個列舉常數都是一個物件。列舉常數之間以逗號分隔。

由於每個列舉都是列舉類別的實例，因此可以像這樣初始化：

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

匿名類別

列舉常數可以宣告自己的匿名類別，並帶有其對應的方法，以及覆寫（overriding）基礎方法。

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

    TALKING {
        override fun signal() = WAITING
    };

    abstract fun signal(): ProtocolState
}

如果列舉類別定義了任何成員，請使用分號將常數定義與成員定義分隔開。

在列舉類別中實作介面

列舉類別可以實作介面（但不能衍生自類別），它為所有條目提供介面成員的共同實作，或在匿名類別中為每個條目提供個別實作。 這可以透過將您想要實作的介面新增到列舉類別宣告中來完成，如下所示：

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)}")
    }
}

所有列舉類別預設都實作 Comparable 介面。列舉類別中的常數依自然順序定義。更多資訊，請參閱 Ordering。

使用列舉常數

Kotlin 中的列舉類別具有合成（synthetic）屬性與方法，用於列出已定義的列舉常數並透過其名稱取得列舉常數。這些方法的簽章如下（假設列舉類別的名稱是 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() 函式用於檢索列舉常數的陣列。

每個列舉常數也具有屬性：name 和 ordinal，用於取得其名稱和在列舉類別宣告中的位置（從 0 開始）：

enum class RGB { RED, GREEN, BLUE }

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

您可以使用 enumValues<T>() 和 enumValueOf<T>() 函式以通用方式存取列舉類別中的常數。在 Kotlin 2.0.0 中，enumEntries<T>() 函式被引入作為 enumValues<T>() 函式的替代方案。enumEntries<T>() 函式會回傳指定列舉型別 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

更多關於內聯函數（inline functions）和實化型別參數（reified type parameters）的資訊，請參閱 Inline functions。