Enum-классы

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

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

Каждая 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.values()) {
        println("$f($a, $b) = ${f.apply(a, b)}")
    }
}

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

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

EnumClass.valueOf(value: String): EnumClass
EnumClass.values(): Array<EnumClass>

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

К константам в enum-классе можно получить доступ универсальным способом, используя функции enumValues<T>() и enumValueOf<T>():

enum class RGB { RED, GREEN, BLUE }

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

printAllValues<RGB>() // выведет RED, GREEN, BLUE

Каждая enum-константа имеет поля, в которых содержатся её имя и порядковый номер в объявлении enum-класса.

val name: String
val ordinal: Int

Также enum-константы реализуют интерфейс Comparable. Порядок сортировки соответствует порядку объявления.