Spec-Zone.ru › Kotlin 1.7

Перечисление

kotlin-stdlib / kotlin / Перечисление
Требования к платформе и версии: JVM (1.0), JS (1.1), Native (1.3)
abstract class Enum<E : Enum<E>> : Comparable<E>

Базовый общий класс всех перечислимых классов. Дополнительную информацию о перечислимых классах см. в документации языка Kotlin.

Конструкторы

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

<init>

Базовый общий класс всех перечислимых классов. Дополнительную информацию о перечислимых классах см. в документации языка Kotlin.

<init>(name: String, ordinal: Int)

Свойства

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

name

Возвращает имя этой константы перечисления, точно так, как оно объявлено в её объявлении.

val name: String
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

ordinal

Возвращает порядковый номер этой константы перечисления (ее позицию в ее объявлении, где начальной константе присваивается порядковый номер ноль).

val ordinal: Int

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

clone

Выбрасывает исключение, так как константы перечисления не могут быть клонированы. Этот метод предотвращает наследование перечислимых классов от Cloneable.

fun clone(): Any
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareTo

Сравнивает этот объект с указанным объектом для определения порядка. Возвращает ноль, если этот объект равен указанному объекту other, отрицательное число, если он меньше other, или положительное число, если он больше other.

fun compareTo(other: E): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

equals

Указывает, является ли какой-либо другой объект "равным" этому. Реализации должны соответствовать следующим требованиям:

fun equals(other: Any?): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

hashCode

Возвращает значение хэш-кода для объекта. Общий контракт hashCode:

fun hashCode(): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toString

Возвращает строковое представление объекта.

open fun toString(): String

Расширяющие свойства

Требования к платформе и версии: JVM (1.7)

declaringJavaClass

Возвращает экземпляр Java Class перечисления, к которому принадлежит данная константа.

val <E : Enum<E>> E.declaringJavaClass: Class<E>

Расширяющие функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceAtLeast

Обеспечивает, что это значение не меньше указанного минимального значения.

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceAtMost

Обеспечивает, что это значение не больше указанного максимального значения.

fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceIn

Обеспечивает, что это значение находится в заданном диапазоне minimumValue..maximumValue.

fun <T : Comparable<T>> T.coerceIn(
    minimumValue: T?, 
    maximumValue: T?
): T

Обеспечивает, что это значение находится в заданном диапазоне.

fun <T : Comparable<T>> T.coerceIn(
    range: ClosedFloatingPointRange<T>
): T
fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T
Требования к платформе и версии: JVM (1.6), JS (1.6), Native (1.6)

compareTo

Сравнивает этот объект с указанным объектом для определения порядка. Возвращает ноль, если этот объект равен указанному другому объекту, отрицательное число, если он меньше другого, или положительное число, если он больше другого.

infix fun <T> Comparable<T>.compareTo(other: T): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

rangeTo

Создаёт диапазон от этого значения Comparable до указанного значения.

operator fun <T : Comparable<T>> T.rangeTo(
    that: T
): ClosedRange<T>
Требования к платформе и версии: JVM (1.7), JS (1.7), Native (1.7)

rangeUntil

Создаёт открытый диапазон от этого значения Comparable до указанного значения.

operator fun <T : Comparable<T>> T.rangeUntil(
    that: T
): OpenEndRange<T>

Наследники

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

AnnotationRetention

Содержит список возможных сохранений аннотаций.

enum class AnnotationRetention
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

AnnotationTarget

Содержит список элементов кода, которые являются возможными целевыми объектами аннотаций.

enum class AnnotationTarget
Требования к платформе и версии: JVM (1.0), JS (1.0)

CharCategory

Представляет общую категорию символа в спецификации Unicode.

enum class CharCategory
Требования к платформе и версии: JVM (1.0)

CharDirectionality

Представляет направленность Unicode символа. Направленность символа используется для вычисления визуального порядка текста.

enum class CharDirectionality
Требования к платформе и версии: Native (1.3)

CpuArchitecture

Архитектура центрального процессора.

enum class CpuArchitecture
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

DeprecationLevel

Возможные уровни устаревания. Уровень определяет, как в коде будут сообщаться об использовании устаревших элементов.

enum class DeprecationLevel
Требования к платформе и версии: JVM (1.6), JS (1.6), Native (1.6)

DurationUnit

Список возможных единиц измерения времени, в которых может быть выражена продолжительность.

enum class DurationUnit
Требования к платформе и версии: JVM (1.0)

FileWalkDirection

Перечисление для описания возможных направлений обхода. Есть два из них: начиная с родительских элементов, заканчивая дочерними, и начиная с дочерних элементов, заканчивая родительскими. Оба используют поиск в глубину.

enum class FileWalkDirection
Требования к платформе и версии: Native (1.3)

FutureState

Состояние объекта будущего.

enum class FutureState
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

InvocationKind

Указывает, сколько раз функция вызывает свой параметр-функцию на месте.

enum class InvocationKind
Требования к платформе и версии: JVM (1.1), JS (1.1), Native (1.1)

KVariance

Представляет вариативность, применяемую к параметру типа на месте объявления (вариативность места объявления) или к типу в проекции (вариативность места использования).

enum class KVariance
Требования к платформе и версии: JVM (1.1)

KVisibility

Видимость — это аспект объявления Kotlin, регулирующий, где это объявление доступно в исходном коде. Видимость может быть изменена с помощью одного из следующих модификаторов: public, protected, internal, private.

enum class KVisibility
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

LazyThreadSafetyMode

Указывает, как экземпляр Lazy синхронизирует инициализацию между несколькими потоками.

enum class LazyThreadSafetyMode
Требования к платформе и версии: Native (1.3)

MemoryModel

Модель памяти.

enum class MemoryModel
Требования к платформе и версии: JVM (1.0)

OnErrorAction

Перечисление, которое может быть использовано для указания поведения функции copyRecursively() в исключительных ситуациях.

enum class OnErrorAction
Требования к платформе и версии: Native (1.3)

OsFamily

Семейство операционных систем.

enum class OsFamily
Требования к платформе и версии: JVM (1.0), JRE7 (1.0)

PathWalkOption

Перечисление для предоставления опций обхода для функции Path.walk. Опции могут быть объединены для формирования нужного порядка обхода и поведения.

enum class PathWalkOption

RegexOption

Предоставляет значения перечислений для установки параметров регулярного выражения.

Требования к платформе и версии: JS (1.1)
enum class RegexOption
Требования к платформе и версии: JVM (1.0)
enum class RegexOption : FlagEnum
Требования к платформе и версии: Native (1.3)

TransferMode

Примечание: современный менеджер памяти Kotlin/Native позволяет совместно использовать объекты между потоками без дополнительных церемоний, поэтому TransferMode имеет эффект только в устаревшем менеджере памяти.

enum class TransferMode

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API