Package org.jetbrains.kotlin.gradle.tasks

Interface KotlinCompileTool

  • All Implemented Interfaces:
    kotlin.Comparable , org.gradle.api.Task , org.gradle.api.plugins.ExtensionAware , org.gradle.api.tasks.util.PatternFilterable 
    
public interface KotlinCompileTool
 implements PatternFilterable, Task

    Represents a Kotlin task participating in some stage of the build by compiling sources or running additional Kotlin tools.

    • 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 source(Object sources) Adds input sources for this task.
      abstract Unit setSource(Object sources) Sets input sources for this task.
      abstract Set<String> getExcludes() Returns the set of exclude patterns.
      abstract Set<String> getIncludes() Returns the set of include patterns.
      abstract FileCollection getSources() The configured task inputs (for example, Kotlin sources) which are used to produce a task artifact.
      abstract ConfigurableFileCollection getLibraries() Collection of external artifacts participating in the output artifact generation.
      abstract DirectoryProperty getDestinationDirectory() The destination directory where the task artifact can be found.

      • Methods inherited from class org.gradle.api.tasks.util.PatternFilterable

        exclude, exclude, exclude, exclude, include, include, include, include, setExcludes, setIncludes

      • Methods inherited from class kotlin.Comparable

        compareTo

      • Methods inherited from class org.gradle.api.plugins.ExtensionAware

        getExtensions

      • Methods inherited from class org.gradle.api.Task

        configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • source

         abstract Unit source(Object sources)

        Adds input sources for this task.

        Parameters:
        sources - object is evaluated as per org.gradle.api.Project.files.

      • setSource

         abstract Unit setSource(Object sources)

        Sets input sources for this task.

        Note: due to a bug, the setSource() function does not update already added sources.

        Parameters:
        sources - object is evaluated as per org.gradle.api.Project.files.

      • getExcludes

        @Internal() abstract Set<String> getExcludes()

        Returns the set of exclude patterns.

        Returns:

        The exclude patterns. Returns an empty set when there are no exclude patterns.

      • getIncludes

        @Internal() abstract Set<String> getIncludes()

        Returns the set of include patterns.

        Returns:

        The include patterns. Returns an empty set when there are no include patterns.

      • getSources

        @InputFiles()@SkipWhenEmpty()@IgnoreEmptyDirectories()@NormalizeLineEndings()@PathSensitive(value = PathSensitivity.RELATIVE) abstract FileCollection getSources()

        The configured task inputs (for example, Kotlin sources) which are used to produce a task artifact.

      • getLibraries

        @Classpath()@Incremental() abstract ConfigurableFileCollection getLibraries()

        Collection of external artifacts participating in the output artifact generation.

        For example, a Kotlin/JVM compilation task has external JAR files or an external location with already compiled class files.

      • getDestinationDirectory

        @OutputDirectory() abstract DirectoryProperty getDestinationDirectory()

        The destination directory where the task artifact can be found.