Package-level declarations
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 (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 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[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
Represents a 8-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type byte
.
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.
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. On the JVM, non-nullable values of this type are represented as values of the primitive type double
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
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.
The experimental multiplatform support API marker.
The experimental multiplatform support API marker.
Marks the API that is dependent on the experimental unsigned types, including those types themselves.
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. On the JVM, non-nullable values of this type are represented as values of the primitive type float
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
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 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.
Represents a version of the Kotlin standard library.
Represents a 64-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type long
.
Represents a 64-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type long
.
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.
An exception is thrown to indicate that a method body remains to be implemented.
Marks an expected annotation class that it isn't required to have actual counterparts in all platforms.
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.
Represents a 16-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type short
.
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[]
.
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.
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
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.
Calls the specified function block with this
value as its argument and returns this
value.
Calls the specified function block with this
value as its receiver and returns this
value.
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.
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 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.
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 /
operator for BigDecimal instances.
Enables the use of the /
operator for BigInteger instances.
Returns true
if this value is infinitely large in magnitude.
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.
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.
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".
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 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.
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.
Calls the specified function block with this
value as its receiver and returns its result.
Returns this
value if it does not satisfy the given predicate or null
, if it does.
Enables the use of the *
operator for BigDecimal instances.
Enables the use of the *
operator for BigInteger instances.
Always throws NotImplementedError stating that operation is not implemented.
Converts this pair into a list.
Converts this triple into a list.
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Enables the use of the unary -
operator for BigDecimal instances.
Enables the use of the unary -
operator for BigInteger instances.