RequiresOptIn

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

@Target([AnnotationTarget.ANNOTATION_CLASS]) annotation class RequiresOptIn

Указывает, что аннотированный класс аннотаций является маркером API, который требует явного opt-in.

Места вызова любого объявления, помеченного этим маркером, должны быть включены в API, либо с помощью OptIn, либо с помощью аннотации самим маркером, что, по сути, вызывает дальнейшее распространение требования opt-in.

Этот класс сам требует opt-in и может использоваться только с аргументом компилятора -Xopt-in=kotlin.RequiresOptIn.

Типы

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

Level

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

enum class Level

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

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

<init>

Указывает, что аннотированный класс аннотаций является маркером API, который требует явного opt-in.

RequiresOptIn(
    message: String = "", 
    level: Level = Level.ERROR)

Свойства

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

level

указывает, как используются API без явного opt-in, в коде.

val level: Level

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

message

сообщение, которое должно быть отображено при использовании API без явного opt-in, или пустая строка для стандартного сообщения. Стандартное сообщение: «Это объявление экспериментальное, и его использование должно быть отмечено с помощью «Marker» или «@OptIn(Marker::class)», где Marker — маркер требования к opt-in.

val message: String

© 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/-requires-opt-in/index.html