---

Enum-классы

Наиболее базовый пример использования enum (перечисления) — это реализация типобезопасных перечислений.

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

Каждая enum-константа является объектом. При объявлении константы разделяются запятыми.

Так как каждая enum-константа является экземпляром enum-класса, она может быть инициализирована:

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

Анонимные классы

Enum-константы могут объявлять собственные анонимные классы с соответствующими методами, а также переопределять методы базового класса.

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

    TALKING {
        override fun signal() = WAITING
    };

    abstract fun signal(): ProtocolState
}

Если enum-класс определяет какие-либо члены, отделяйте объявления констант от объявлений членов точкой с запятой.

Реализация интерфейсов в классах 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-класса объявляются в естественном порядке. Подробнее см. в разделе Сортировка.

Работа с enum-константами

Enum-классы в Kotlin имеют синтетические свойства и методы для получения списка объявленных enum-констант и получения enum-константы по её имени. Ниже приведены сигнатуры этих методов (при условии, что имя enum-класса — EnumClass):

EnumClass.valueOf(value: String): EnumClass
EnumClass.entries: EnumEntries<EnumClass> // специализированный List<EnumClass>

Ниже приведён пример их использования:

enum class RGB { RED, GREEN, BLUE }

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

Метод valueOf() выбрасывает исключение IllegalArgumentException, если указанное имя не соответствует ни одной enum-константе, объявленной в классе.

До появления entries в Kotlin 1.9.0 для получения массива enum-констант использовалась функция values().

У каждой enum-константы также есть свойства name и ordinal, которые позволяют получить её имя и позицию (начиная с 0) в объявлении enum-класса:

enum class RGB { RED, GREEN, BLUE }

fun main() {
    println(RGB.RED.name)    // выведет RED
    println(RGB.RED.ordinal) // выведет 0
}

Совет. Чтобы сократить повторения при работе с записями enum, попробуйте контекстно-зависимое разрешение (сейчас доступно в предварительном режиме). Эта возможность позволяет опускать имя enum-класса, когда ожидаемый тип известен, например в выражениях when или при присваивании переменной с явным типом.

Подробнее см. в разделе Preview of context-sensitive resolution и в соответствующем KEEP-предложении.

К константам в enum-классе можно получить доступ универсальным способом, используя функции enumValues<T>() и enumValueOf<T>(). В Kotlin 2.0.0 функция enumEntries<T>() появилась как замена функции enumValues<T>(). Функция enumEntries<T>() возвращает список всех записей enum для заданного 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

Подробнее о встроенных функциях и reified-параметрах типа см. в разделе Встроенные (inline) функции.