Package-level declarations
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Types
Base interface implicitly implemented by all annotation interfaces. See Kotlin language documentation for more information on annotations.
Base interface implicitly implemented by all annotation interfaces. See Kotlin language documentation for more information on annotations.
Represents an array (specifically, a Java array when targeting the JVM platform). Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions. See Kotlin language documentation for more information on arrays.
Represents an array. Array instances can be created using the constructor, arrayOf, arrayOfNulls and emptyArray standard library functions. See Kotlin language documentation for more information on arrays.
Represents a value which is either true
or false
. On the JVM, non-nullable values of this type are represented as values of the primitive type boolean
.
Represents a value which is either true
or false
. On the JVM, non-nullable values of this type are represented as values of the primitive type boolean
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
Allows to infer generic type arguments of a function from the calls in the annotated function parameter of that function.
Represents a 8-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type byte
.
Classes which inherit from this interface have a defined total ordering between their instances.
Classes which inherit from this interface have a defined total ordering between their instances.
Provides a comparison function for imposing a total ordering between instances of the type T.
Marks the annotated declaration as deprecated.
Marks the annotated declaration as deprecated.
Possible levels of a deprecation. The level specifies how the deprecated element usages are reported in code.
Possible levels of a deprecation. The level specifies how the deprecated element usages are reported in code.
Represents a double-precision 64-bit IEEE 754 floating point number. On the JVM, non-nullable values of this type are represented as values of the primitive type double
.
Represents a double-precision 64-bit IEEE 754 floating point number.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
When applied to annotation class X specifies that X defines a DSL language
When applied to annotation class X specifies that X defines a DSL language
The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.
The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.
Signals that the annotated annotation class is a marker of an experimental API.
The experimental multiplatform support API marker.
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.
Marks the API that is dependent on the experimental unsigned types, including those types themselves.
Signifies that the annotated functional type represents an extension function.
Signifies that the annotated functional type represents an extension function.
Represents a single-precision 32-bit IEEE 754 floating point number. On the JVM, non-nullable values of this type are represented as values of the primitive type float
.
Represents a single-precision 32-bit IEEE 754 floating point number.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
Represents a 32-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type int
.
Represents a version of the Kotlin standard library.
Specifies how a Lazy instance synchronizes initialization among multiple threads.
Represents a 64-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type long
.
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.
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
An exception is thrown to indicate that a method body remains to be implemented.
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.
Annotates type arguments of functional type and holds corresponding parameter name specified by the user in type declaration (if any).
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.
When applied to a class or a member with internal visibility allows to use it from public inline functions and makes it effectively public.
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.
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.
Represents a 16-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type short
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
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.
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.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
Suppresses the given compilation warnings in the annotated element.
Suppresses the given compilation warnings in the annotated element.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
Suppresses errors about variance conflict
Suppresses errors about variance conflict
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.
Properties
Functions
When supported by the platform, adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Performs a bitwise AND operation between the two values.
Returns an array containing the specified elements.
Returns an array of objects of the given type with the given size, initialized with null values.
Throws an AssertionError if the value is false and runtime assertions have been enabled on the JVM using the -ea JVM option.
Throws an AssertionError calculated by lazyMessage if the value is false and runtime assertions have been enabled on the JVM using the -ea JVM option.
Throws an AssertionError if the value is false and runtime assertions have been enabled during compilation.
Throws an AssertionError calculated by lazyMessage if the value is false and runtime assertions have been enabled during compilation.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Throws an IllegalStateException if the value is false.
Throws an IllegalStateException with the result of calling lazyMessage if the value is false.
Throws an IllegalStateException if the value is null. Otherwise returns the not null value.
Throws an IllegalStateException with the result of calling lazyMessage if the value is null. Otherwise returns the not null value.
Enables the use of the unary --
operator for BigDecimal instances.
Enables the use of the --
operator for BigInteger instances.
Enables the use of the /
operator for BigDecimal instances.
Enables the use of the /
operator for BigInteger instances.
Returns the result of onSuccess for the encapsulated value if this instance represents success or the result of onFailure function for the encapsulated Throwable exception if it is failure.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Enables the use of the unary ++
operator for BigDecimal instances.
Enables the use of the ++
operator for BigInteger instances.
Inverts the bits including the sign bit in this value.
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Creates a new instance of the Lazy that uses the specified initialization function initializer.
Creates a new instance of the Lazy that uses the specified initialization function initializer.
Creates a new instance of the Lazy that uses the specified initialization function initializer and the default thread-safety mode LazyThreadSafetyMode.SYNCHRONIZED.
Creates a new instance of the Lazy that uses the specified initialization function initializer and thread-safety mode.
Creates a new instance of the Lazy that uses the specified initialization function initializer and the default thread-safety mode LazyThreadSafetyMode.SYNCHRONIZED.
Creates a new instance of the Lazy that uses the specified initialization function initializer and thread-safety mode.
Enables the use of the -
operator for BigDecimal instances.
Enables the use of the -
operator for BigInteger instances.
Performs a bitwise OR operation between the two values.
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Enables the use of the +
operator for BigDecimal instances.
Enables the use of the +
operator for BigInteger instances.
Prints the detailed description of this throwable to the standard error output.
Prints the detailed description of this throwable to the specified stream.
Prints the detailed description of this throwable to the specified writer.
Enables the use of the %
operator for BigDecimal instances.
Enables the use of the %
operator for BigInteger instances.
Throws an IllegalArgumentException if the value is false.
Throws an IllegalArgumentException with the result of calling lazyMessage if the value is false.
Throws an IllegalArgumentException if the value is null. Otherwise returns the not null value.
Throws an IllegalArgumentException with the result of calling lazyMessage if the value is null. Otherwise returns the not null value.
Shifts this value left by the n number of bits.
Shifts this value right by the n number of bits, filling the leftmost bits with copies of the sign bit.
Enables the use of the *
operator for BigDecimal instances.
Enables the use of the *
operator for BigInteger instances.
Returns the value of this BigInteger number as a BigDecimal.
Returns the value of this Double number as a BigDecimal.
Returns the value of this Float number as a BigDecimal.
Returns the value of this Int number as a BigDecimal.
Returns the value of this Long number as a BigDecimal.
Returns the value of this BigInteger number as a BigDecimal scaled according to the specified scale and rounded according to the settings specified with mathContext.
Returns the value of this Int number as a BigInteger.
Returns the value of this Long number as a BigInteger.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Enables the use of the unary -
operator for BigDecimal instances.
Enables the use of the unary -
operator for BigInteger instances.
Performs a bitwise XOR operation between the two values.