Annotation

Common
JVM
JS
Native
1.0
interface Annotation

Base interface implicitly implemented by all annotation interfaces. See Kotlin language documentation for more information on annotations.

Extension Properties

JVM
1.0

annotationClass

Returns a KClass instance corresponding to the annotation type of this annotation.

val <T : Annotation> T.annotationClass: KClass<out T>

Inheritors

Common
JVM
JS
Native
1.3

BuilderInference

Allows to infer generic type arguments of a function from the calls in the annotated function parameter of that function.

annotation class BuilderInference
Native
1.3

CName

Makes top level function available from C/C++ code with the given name.

annotation class CName
Common
JVM
JS
Native
1.0

Deprecated

Marks the annotated class, function, property, variable or parameter as deprecated.

annotation class Deprecated
Common
JVM
JS
Native
1.1

DslMarker

When applied to annotation class X specifies that X defines a DSL language

annotation class DslMarker
Common
JVM
JS
Native
1.2

Experimental

Signals that the annotated annotation class is a marker of an experimental API.

annotation class Experimental
Common
JVM
JS
Native
1.3

ExperimentalContracts

This marker distinguishes the experimental contract declaration API and is used to opt-in for that feature when declaring contracts of user functions.

annotation class ExperimentalContracts
Common
JVM
JS
Native
1.0

ExperimentalMultiplatform

The experimental multiplatform support API marker.

annotation class ExperimentalMultiplatform
Common
JVM
JS
Native
1.3

ExperimentalTypeInference

The experimental type inference augmenting annotations marker.

annotation class ExperimentalTypeInference
Common
JVM
JS
Native
1.0

ExperimentalUnsignedTypes

Marks the API that is dependent on the experimental unsigned types, including those types themselves.

annotation class ExperimentalUnsignedTypes
Native
1.3

ExportObjCClass

Makes Kotlin subclass of Objective-C class visible for runtime lookup after Kotlin main function gets invoked.

annotation class ExportObjCClass
Common
JVM
JS
Native
1.0

ExtensionFunctionType

Signifies that the annotated functional type represents an extension function.

annotation class ExtensionFunctionType
Native
1.3

ExternalObjCClass

annotation class ExternalObjCClass
Native
1.3

InteropStubs

annotation class InteropStubs
JS
1.1

JsModule

Denotes an external declaration that must be imported from native JavaScript library.

annotation class JsModule
Common
JS
1.0

JsName

Gives a declaration (a function, a property or a class) specific name in JavaScript.

annotation class JsName
JS
1.1

JsNonModule

Denotes an external declaration that can be used without module system.

annotation class JsNonModule
JS
1.1

JsQualifier

Adds prefix to external declarations in a source file.

annotation class JsQualifier
JVM
1.2

JvmDefault

Specifies that a JVM default method should be generated for non-abstract Kotlin interface member.

annotation class JvmDefault
Common
JVM
1.0

JvmField

Instructs the Kotlin compiler not to generate getters/setters for this property and expose it as a field.

annotation class JvmField
Common
JVM
1.0

JvmMultifileClass

Instructs the Kotlin compiler to generate a multifile class with top-level functions and properties declared in this file as one of its parts. Name of the corresponding multifile class is provided by the JvmName annotation.

annotation class JvmMultifileClass
Common
JVM
1.0

JvmName

Specifies the name for the Java class or method which is generated from this element.

annotation class JvmName
Common
JVM
1.0

JvmOverloads

Instructs the Kotlin compiler to generate overloads for this function that substitute default parameter values.

annotation class JvmOverloads
Common
JVM
1.0

JvmStatic

Specifies that an additional static method needs to be generated from this element if it's a function. If this element is a property, additional static getter/setter methods should be generated.

annotation class JvmStatic
Common
JVM
1.0

JvmSuppressWildcards

Instructs compiler to generate or omit wildcards for type arguments corresponding to parameters with declaration-site variance, for example such as Collection<out T> has.

annotation class JvmSuppressWildcards
Common
JVM
1.0

JvmSynthetic

Sets ACC_SYNTHETIC flag on the annotated target in the Java bytecode.

annotation class JvmSynthetic
Common
JVM
1.0

JvmWildcard

Instructs compiler to generate wildcard for annotated type arguments corresponding to parameters with declaration-site variance.

annotation class JvmWildcard
JVM
1.3

Metadata

This annotation is present on any class file produced by the Kotlin compiler and is read by the compiler and reflection. Parameters have very short JVM names on purpose: these names appear in all generated class files, and we'd like to reduce their size.

annotation class Metadata
Common
JVM
JS
Native
1.0

MustBeDocumented

This meta-annotation determines that an annotation is a part of public API and therefore should be included in the generated documentation for the element to which the annotation is applied.

annotation class MustBeDocumented
JS
1.1

native

annotation class native
JS
1.1

nativeGetter

annotation class nativeGetter
JS
1.1

nativeInvoke

annotation class nativeInvoke
JS
1.1

nativeSetter

annotation class nativeSetter
Native
1.3

ObjCAction

Makes Kotlin method in Objective-C class accessible through Objective-C dispatch to be used as action sent by control in UIKit or AppKit.

annotation class ObjCAction
Native
1.3

ObjCBridge

annotation class ObjCBridge
Native
1.3

ObjCConstructor

annotation class ObjCConstructor
Native
1.3

ObjCFactory

annotation class ObjCFactory
Native
1.3

ObjCMethod

annotation class ObjCMethod
Native
1.3

ObjCOutlet

Makes Kotlin property in Objective-C class settable through Objective-C dispatch to be used as IB outlet.

annotation class ObjCOutlet
Common
JVM
JS
Native
1.0

OptionalExpectation

Marks an expected annotation class that it isn't required to have actual counterparts in all platforms.

annotation class OptionalExpectation
Common
JVM
JS
Native
1.1

ParameterName

Annotates type arguments of functional type and holds corresponding parameter name specified by the user in type declaration (if any).

annotation class ParameterName
Common
JVM
JS
Native
1.1

PublishedApi

When applied to a class or a member with internal visibility allows to use it from public inline functions and makes it effectively public.

annotation class PublishedApi
JVM
1.0

PurelyImplements

Instructs the Kotlin compiler to treat annotated Java class as pure implementation of given Kotlin interface. "Pure" means here that each type parameter of class becomes non-platform type argument of that interface.

annotation class PurelyImplements
Common
JVM
JS
Native
1.0

Repeatable

This meta-annotation determines that an annotation is applicable twice or more on a single code element

annotation class Repeatable
Common
JVM
JS
Native
1.0

ReplaceWith

Specifies a code fragment that can be used to replace a deprecated function, property or class. Tools such as IDEs can automatically apply the replacements specified through this annotation.

annotation class ReplaceWith
Common
JVM
JS
Native
1.3

RestrictsSuspension

Classes and interfaces marked with this annotation are restricted when used as receivers for extension suspend functions. These suspend extensions can only invoke other member or extension suspend functions on this particular receiver only and are restricted from calling arbitrary suspension functions.

annotation class RestrictsSuspension
Common
JVM
JS
Native
1.1

RestrictsSuspension

Classes and interfaces marked with this annotation are restricted when used as receivers for extension suspend functions. These suspend extensions can only invoke other member or extension suspend functions on this particular receiver only and are restricted from calling arbitrary suspension functions.

annotation class RestrictsSuspension
Native
1.3

Retain

Preserve the function entry point during global optimizations.

annotation class Retain
Common
JVM
JS
Native
1.0

Retention

This meta-annotation determines whether an annotation is stored in binary output and visible for reflection. By default, both are true.

annotation class Retention
Native
1.3

SharedImmutable

Top level variable is immutable and so could be shared. PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.

annotation class SharedImmutable
Common
JVM
JS
Native
1.0

SinceKotlin

Specifies the first version of Kotlin where a declaration has appeared. Using the declaration and specifying an older API version (via the -api-version command line option) will result in an error.

annotation class SinceKotlin
Common
JVM
1.0

Strictfp

Marks the JVM method generated from the annotated function as strictfp, meaning that the precision of floating point operations performed inside the method needs to be restricted in order to achieve better portability.

annotation class Strictfp
Common
JVM
JS
Native
1.0

Suppress

Suppresses the given compilation warnings in the annotated element.

annotation class Suppress
Native
1.3

SymbolName

Forces the compiler to use specified symbol name for the target external function.

annotation class SymbolName
Common
JVM
JS
1.0

Synchronized

Marks the JVM method generated from the annotated function as synchronized, meaning that the method will be protected from concurrent execution by multiple threads by the monitor of the instance (or, for static methods, the class) on which the method is defined.

annotation class Synchronized

Synchronized

JS
1.1
typealias Synchronized = Synchronized
Native
1.3
annotation class Synchronized
Common
JVM
JS
Native
1.0

Target

This meta-annotation indicates the kinds of code elements which are possible targets of an annotation.

annotation class Target
Native
1.3

ThreadLocal

Top level variable or object is thread local, and so could be mutable. One may use this annotation as the stopgap measure for singleton object immutability. PLEASE NOTE THAT THIS ANNOTATION MAY GO AWAY IN UPCOMING RELEASES.

annotation class ThreadLocal
JVM
1.0

Throws

This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.

annotation class Throws
Native
1.3

Throws

This annotation indicates what exceptions should be declared by a function when compiled to a platform method.

annotation class Throws
Common
JVM
1.0

Transient

Marks the JVM backing field of the annotated property as transient, meaning that it is not part of the default serialized form of the object.

annotation class Transient
Common
JVM
JS
Native
1.0

UnsafeVariance

Suppresses errors about variance conflict

annotation class UnsafeVariance
Common
JVM
JS
Native
1.2

UseExperimental

Allows to use experimental API denoted by the given markers in the annotated file, declaration, or expression. If a declaration is annotated with UseExperimental, its usages are not required to opt-in to that experimental API.

annotation class UseExperimental
Common
JVM
JS
1.0

Volatile

Marks the JVM backing field of the annotated property as volatile, meaning that writes to this field are immediately made visible to other threads.

annotation class Volatile

Volatile

JS
1.1
typealias Volatile = Volatile
Native
1.3
annotation class Volatile