枚举类

枚举类最基本的用例是实现类型安全的枚举：

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

每个枚举常量都是一个对象。枚举常量之间用逗号分隔。

由于每个枚举都是枚举类的一个实例，它可以像这样初始化：

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

匿名类

枚举常量可以声明自己的匿名类，并包含相应的方法，以及重写（override）基类方法。

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 接口。枚举类中的常量按自然顺序定义。有关更多信息，请参阅排序。

使用枚举常量

Kotlin 中的枚举类具有合成属性和方法，用于列出定义的枚举常量以及按名称获取枚举常量。这些方法的签名如下（假设枚举类的名称为 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

有关内联函数和具体化类型参数的更多信息，请参阅内联函数。