Annotation

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

Makes the annotated annotation class an associated object key.

Marks Objective-C and Swift interoperability API as Beta.

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

Denotes property that is an alias to some enum entry.

Stores instance size of the type T: CEnumVar.

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

In previous versions of Kotlin, the generated 'copy' method of a data class always had public visibility, even if the primary constructor was non-public. That exposed the non-public constructor of the data class.

Signifies that the annotated functional type has the prefix of size count for context receivers. Thus, @ContextFunctionTypeParams(2) @ExtensionFunctionType Function4<String, Int, Double, Byte, Unit> is a normalized representation of context(String, Int) Double.(Byte) -> Unit.

Marks the annotated declaration as deprecated.

Marks the annotated declaration as deprecated. In contrast to Deprecated, severity of the reported diagnostic is not a constant value, but differs depending on the API version of the usage (the value of the -api-version argument when compiling the module where the usage is located). If the API version is greater or equal than hiddenSince, the declaration will not be accessible from the code (as if it was deprecated with level DeprecationLevel.HIDDEN), otherwise if the API version is greater or equal than errorSince, the usage will be marked as an error (as with DeprecationLevel.ERROR), otherwise if the API version is greater or equal than warningSince, the usage will be marked as a warning (as with DeprecationLevel.WARNING), otherwise the annotation is ignored.

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

Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property.

Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property. This annotation can be used as temporal migration assistance during the transition from the previous Kotlin/Native initialization scheme "eager by default" to the new one, "lazy by default".

The experimental marker for associated objects API.

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

This annotation marks the experimental API for encoding and decoding between binary data and printable ASCII character sequences.

Marks foreign-language-related API as experimental.

This annotation marks the experimental JS-collections API that allows to manipulate with native JS-collections The API can be removed completely in any further release.

Marks experimental JS export annotations.

Marks experimental JsFileName annotation.

This annotation marks the experimental Kotlin/JS reflection API that allows to create an instance of provided KClass The API can be removed completely in any further release.

Marks the experimental JsStatic annotation.

The experimental multiplatform support API marker.

This annotation marks the Kotlin/Native-only standard library API that is considered experimental and is not subject to the general compatibility guarantees given for the standard library: the behavior of such API may be changed or the API may be removed completely in any further release.

This annotation marks the experimental ObjCName annotation.

This annotation marks the experimental Objective-C export refinement annotations.

This annotation marks the extensions and top-level functions for working with java.nio.file.Path considered experimental.

This annotation marks the experimental kotlin-reflect API that allows to approximate a Kotlin lambda or a function expression instance to a KFunction instance. The behavior of this API may be changed or the API may be removed completely in any further release.

This annotation marks the standard library API that is considered experimental and is not subject to the general compatibility guarantees given for the standard library: the behavior of such API may be changed or the API may be removed completely in any further release.

This annotation marks the experimental preview of the language feature SubclassOptInRequired.

This annotation marks the experimental preview of the standard library API for measuring time and working with durations.

The experimental marker for type inference augmenting annotations.

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

This annotation marks the experimental Kotlin Uuid API.

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

In previous versions of Kotlin, the generated 'copy' method of a data class always had public visibility, even if the primary constructor was non-public. That exposed the non-public constructor of the data class.

Signifies that the annotated functional type represents an extension function.

Freezing API is deprecated since 1.7.20.

Instructs the Kotlin compiler to remove this class, function or property from the public Objective-C API.

Meta-annotation that instructs the Kotlin compiler to remove the annotated class, function or property from the public Objective-C API.

This annotation marks Kotlin expect declarations that are implicitly actualized by Java.

Exports top-level declaration on JS platform.

When placed on a function parameter, requires the type of the passed argument to be external.

When placed on an external interface or class, requires all its child interfaces, classes, and objects to be external as well.

Specifies the name of the compiled file produced from the annotated source file instead of the default one.

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

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

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

Adds prefix to external declarations in a source file.

Specifies that an additional static method is generated from the annotated companion object member if it's a function. If the member is a property, additional static getter/setter methods are generated.

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

Forces the compiler to generate compatibility accessors for the annotated interface in the DefaultImpls class. Please note that if an interface is annotated with this annotation for binary compatibility, public derived Kotlin interfaces should also be annotated with it, because their DefaultImpls methods will be used to access implementations from the DefaultImpls class of the original interface.

Prevents the compiler from generating compatibility accessors for the annotated class or interface, and suppresses any related compatibility warnings. In other words, this annotation makes the compiler generate the annotated class or interface in the -Xjvm-default=all mode, where only JVM default methods are generated, without DefaultImpls.

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

Specifies that given value class is inline class.

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.

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

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

Instructs compiler to mark the class as a record and generate relevant toString/equals/hashCode methods

Makes the annotated lambda function implement java.io.Serializable, generates a pretty toString implementation and adds reflection metadata.

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.

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.

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

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

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.

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.

This annotation marks the Kotlin/Native standard library API that tweaks or otherwise accesses the Kotlin runtime behavior.

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

Instructs the Kotlin compiler to use a custom Objective-C and/or Swift name for this class, property, parameter or function.

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

Marks functions for which Objective-C rules should be used for determinating whether two functions are conflicting.

This annotation marks the Kotlin/Native standard library API that is considered obsolete and is being phased out.

Marks all Worker-related API as obsolete.

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

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

Enables overload selection based on the type of the value returned from lambda argument.

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

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

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.

Meta-annotation that instructs the Kotlin compiler to mark the annotated function or property as swift_private in the generated Objective-C API.

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

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.

Signals that the annotated annotation class is a marker of an API that requires an explicit opt-in.

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 and are restricted from calling arbitrary suspension functions.

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

Note: this annotation has effect only in Kotlin/Native with legacy memory manager.

Instructs the Kotlin compiler to mark this function or property as swift_private in the generated Objective-C API.

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.

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 that marks open for subclassing classes and interfaces, and makes implementation and extension of such declarations as requiring an explicit opt-in.

Suppresses the given compilation warnings in the annotated element.

This is a dangerous deprecated and internal annotation. Please avoid using it.

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.

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

Marks a top level property with a backing field or an object as thread local. The object remains mutable and it is possible to change its state, but every thread will have a distinct copy of this object, so changes in one thread are not reflected in another.

This annotation indicates what exceptions should be declared by a function when compiled to a platform method in Kotlin/JVM and Kotlin/Native.

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

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.

Marker for declarations that depend on numeric types of different bit width on at least two platforms.

Suppresses errors about variance conflict

Marks the JVM backing field of the annotated var property as volatile, meaning that reads and writes to this field are atomic and writes are always made visible to other threads. If another thread reads the value of this field (e.g. through its accessor), it sees not only that value, but all side effects that led to writing that value.

Marks the backing field of the annotated var property as volatile, meaning that reads and writes to this field are atomic and writes are always made visible to other threads. If another thread reads the value of this field (e.g. through its accessor), it sees not only that value, but all side effects that led to writing that value.