kotlin-stdlib/kotlin.jvm

Package-level declarations

Functions and annotations specific to the Java platform.

Types

JvmField

@Target(allowedTargets = [AnnotationTarget.FIELD])

expect annotation class JvmField

@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.

Since Kotlin 1.0

JvmMultifileClass

@Target(allowedTargets = [AnnotationTarget.FILE])

expect annotation class JvmMultifileClass

@Target(allowedTargets = [AnnotationTarget.FILE])

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

Since Kotlin 1.0

JvmName

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

expect annotation class JvmName(val name: String)

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

actual annotation class JvmName(val name: String)

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

Since Kotlin 1.0

JvmOverloads

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

expect annotation class JvmOverloads

@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.

Since Kotlin 1.0

JvmStatic

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

expect annotation class JvmStatic

@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.

Since Kotlin 1.0

JvmSuppressWildcards

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

expect annotation class JvmSuppressWildcards(val suppress: Boolean = true)

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

actual annotation class JvmSuppressWildcards(val suppress: Boolean = true)

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.

Since Kotlin 1.0

JvmSynthetic

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

expect annotation class JvmSynthetic

@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.

Since Kotlin 1.0

JvmWildcard

@Target(allowedTargets = [AnnotationTarget.TYPE])

expect annotation class JvmWildcard

@Target(allowedTargets = [AnnotationTarget.TYPE])

actual annotation class JvmWildcard

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

Since Kotlin 1.0

PurelyImplements

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PurelyImplements(val 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.

Since Kotlin 1.0

Strictfp

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

expect annotation class Strictfp

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

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

Since Kotlin 1.0

Synchronized

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

expect annotation class Synchronized

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

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

Since Kotlin 1.0

Throws