Package kotlin.jvm

Functions and annotations specific to the Java platform.

Types

JvmDefault

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

~~annotation class~~ ~~JvmDefault~~

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

Since Kotlin

1.2

JvmDefaultWithoutCompatibility

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class JvmDefaultWithoutCompatibility

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.

Since Kotlin

1.4

JvmField

@Target(allowedTargets = [AnnotationTarget.FIELD])

expect annotation class JvmField

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

@Target(allowedTargets = [AnnotationTarget.FIELD])

actual annotation class JvmField

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

JvmInline

@Target(allowedTargets = [AnnotationTarget.CLASS])

expect annotation class JvmInline

Specifies that given value class is inline class.

Since Kotlin

1.5

@Target(allowedTargets = [AnnotationTarget.CLASS])

actual annotation class JvmInline

Specifies that given value class is inline class.

Since Kotlin

1.5

JvmMultifileClass

@Target(allowedTargets = [AnnotationTarget.FILE])

expect annotation class 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.

@Target(allowedTargets = [AnnotationTarget.FILE])

actual annotation class JvmMultifileClass

JvmName

@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

expect annotation class JvmName(name: String)

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

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.FILE])

actual annotation class JvmName(name: String)

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

JvmOverloads

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

expect annotation class JvmOverloads

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

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

actual annotation class JvmOverloads

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

JvmRecord

@Target(allowedTargets = [AnnotationTarget.CLASS])

expect annotation class JvmRecord

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

Since Kotlin

1.5

@Target(allowedTargets = [AnnotationTarget.CLASS])

actual annotation class JvmRecord

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

Since Kotlin

1.5

JvmStatic

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

expect annotation class 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.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

actual annotation class 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.

JvmSuppressWildcards

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPE])

expect annotation class JvmSuppressWildcards(suppress: Boolean)

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.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPE])

actual annotation class JvmSuppressWildcards(suppress: Boolean)

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.

JvmSynthetic

@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.FIELD])

expect annotation class JvmSynthetic

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

@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.FIELD])

actual annotation class JvmSynthetic

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

JvmWildcard

@Target(allowedTargets = [AnnotationTarget.TYPE])

expect annotation class JvmWildcard

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

@Target(allowedTargets = [AnnotationTarget.TYPE])

actual annotation class JvmWildcard

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

KotlinReflectionNotSupportedError

open class KotlinReflectionNotSupportedError : Error

PurelyImplements

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PurelyImplements(value: String)

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PurelyImplements(value: String)

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.

Strictfp

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CLASS])

expect annotation class 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.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CLASS])

actual annotation class Strictfp

Synchronized

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

expect annotation class 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.