Package org.jetbrains.kotlin.gradle.dsl

Interface KotlinTopLevelExtensionConfig

  • All Implemented Interfaces:
    @KotlinGradlePluginDsl() 
public interface KotlinTopLevelExtensionConfig

    A plugin DSL extension for configuring common options for the entire project.

    Use the extension in your build script in the kotlin block:

    kotlin {
   // Your extension configuration
}

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit explicitApi() Sets explicitApi option to report issues as errors.
      abstract Unit explicitApiWarning() Sets explicitApi option to report issues as warnings.
      abstract String getCoreLibrariesVersion() Specifies the version of the core Kotlin libraries that are added to the Kotlin compile classpath, unless there is already a dependency added to this project.
      abstract Unit setCoreLibrariesVersion(String coreLibrariesVersion) Specifies the version of the core Kotlin libraries that are added to the Kotlin compile classpath, unless there is already a dependency added to this project.
      abstract ExplicitApiMode getExplicitApi() Configures default explicit API mode for all non-test compilations in the project.
      abstract Unit setExplicitApi(ExplicitApiMode explicitApi) Configures default explicit API mode for all non-test compilations in the project.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getCoreLibrariesVersion

         abstract String getCoreLibrariesVersion()

        Specifies the version of the core Kotlin libraries that are added to the Kotlin compile classpath, unless there is already a dependency added to this project.

        The core Kotlin libraries are:

        • 'kotlin-stdlib'

        • 'kotlin-test'

        • 'kotlin-dom-api-compat'

        Default: The same version as the version used in the Kotlin Gradle plugin

      • setCoreLibrariesVersion

         abstract Unit setCoreLibrariesVersion(String coreLibrariesVersion)

        Specifies the version of the core Kotlin libraries that are added to the Kotlin compile classpath, unless there is already a dependency added to this project.

        The core Kotlin libraries are:

        • 'kotlin-stdlib'

        • 'kotlin-test'

        • 'kotlin-dom-api-compat'

        Default: The same version as the version used in the Kotlin Gradle plugin

      • getExplicitApi

         abstract ExplicitApiMode getExplicitApi()

        Configures default explicit API mode for all non-test compilations in the project.

        This mode tells the compiler if and how to report issues on all public API declarations that don't have an explicit visibility or return type.

        Default: null

      • setExplicitApi

         abstract Unit setExplicitApi(ExplicitApiMode explicitApi)

        Configures default explicit API mode for all non-test compilations in the project.

        This mode tells the compiler if and how to report issues on all public API declarations that don't have an explicit visibility or return type.

        Default: null