Запрещено к использованию

kotlin-stdlib / kotlin / Запрещено к использованию

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

@Target([AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.TYPEALIAS]) annotation class Deprecated

Помечает аннотированное объявление как устаревшее.

Элемент устаревшего API не рекомендуется использовать, обычно потому, что он отменяется или существует лучшая альтернатива.

Чтобы помочь в постепенном удалении устаревшего API, можно использовать свойство level. Обычно постепенное исключение происходит в стадии «предупреждение», затем «ошибка», затем «скрыто» или «удалено»:

Сначала, и по умолчанию, используется DeprecationLevel.WARNING, чтобы оповестить потребителей API, но не нарушить их компиляцию или использование во время выполнения.
Затем, через некоторое время, уровень устаревания повышается до DeprecationLevel.ERROR, чтобы новый код Kotlin не мог компилироваться с использованием устаревшего API.
Наконец, API полностью удаляется или скрывается (DeprecationLevel.HIDDEN) из кода, так что его использование выглядит как неразрешенные ссылки, в то время как API остается в скомпилированном коде, сохраняя двоичную совместимость с ранее скомпилированным кодом.

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

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

<init>

Помечает аннотированное объявление как устаревшее.

<init>(
    message: String, 
    replaceWith: ReplaceWith = ReplaceWith(""), 
    level: DeprecationLevel = DeprecationLevel.WARNING)

Свойства

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

level

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

val level: DeprecationLevel

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

message

Сообщение, объясняющее устаревание и рекомендующее альтернативный API для использования.

val message: String

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

replaceWith

Если присутствует, указывает фрагмент кода, который следует использовать в качестве замены использования устаревшего API.

val replaceWith: ReplaceWith

© 2010–2020 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/-deprecated/index.html