열거형 클래스

열거형 클래스의 가장 기본적인 사용 사례는 타입-세이프(type-safe) 열거형의 구현입니다:

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

각 열거형 상수는 객체입니다. 열거형 상수는 쉼표로 구분됩니다.

각 열거형은 열거형 클래스의 인스턴스이므로 다음과 같이 초기화할 수 있습니다:

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
}

열거형 클래스가 어떤 멤버를 정의하는 경우, 상수 정의와 멤버 정의를 세미콜론으로 구분합니다.

열거형 클래스에서 인터페이스 구현하기

열거형 클래스는 인터페이스를 구현할 수 있으며(하지만 클래스에서 파생될 수는 없습니다), 모든 엔트리에 대해 인터페이스 멤버의 공통 구현을 제공하거나, 각 엔트리 내부의 익명 클래스에서 별도의 구현을 제공할 수 있습니다. 이는 다음과 같이 열거형 클래스 선언에 구현하려는 인터페이스를 추가하여 수행됩니다:

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 properties)와 메서드가 있습니다. 이 메서드들의 시그니처는 다음과 같습니다 (열거형 클래스 이름이 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() 함수가 열거형 상수의 배열을 검색하는 데 사용되었습니다.

모든 열거형 상수에는 열거형 클래스 선언 내에서 해당 이름과 위치(0부터 시작)를 얻기 위한 name 및 ordinal 프로퍼티도 있습니다:

enum class RGB { RED, GREEN, BLUE }

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

열거형 엔트리를 사용할 때 반복을 줄이려면 상황별 해결(context-sensitive resolution)(현재 프리뷰)을 시도해 보세요. 이 기능은 when 표현식에서 또는 타입이 지정된 변수에 할당할 때와 같이 예상되는 타입이 알려진 경우 열거형 클래스 이름을 생략할 수 있게 해줍니다.

더 자세한 내용은 상황별 해결 프리뷰 또는 관련 KEEP 제안을 참조하세요.

enumValues<T>() 및 enumValueOf<T>() 함수를 사용하여 열거형 클래스의 상수를 일반적인 방식으로 액세스할 수 있습니다. Kotlin 2.0.0에서는 enumValues<T>() 함수를 대체하여 enumEntries<T>() 함수가 도입되었습니다. enumEntries<T>() 함수는 주어진 열거형 타입 T에 대한 모든 열거형 엔트리 목록을 반환합니다.

enumValues<T>() 함수는 여전히 지원되지만, enumEntries<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

인라인 함수(inline functions)와 리파이드 타입 파라미터(reified type parameters)에 대한 자세한 내용은 인라인 함수를 참조하세요.