Interface BaseKapt
-
- All Implemented Interfaces:
-
kotlin.Comparable
,org.gradle.api.Named
,org.gradle.api.Task
,org.gradle.api.plugins.ExtensionAware
,org.jetbrains.kotlin.gradle.tasks.UsesKotlinJavaToolchain
public interface BaseKapt implements Task, UsesKotlinJavaToolchain
Represents a Kotlin task that runs annotation processing using Kotlin/Kapt.
Note: Always run this task after its related KaptGenerateStubs and KotlinJvmCompile tasks.
-
-
Method Summary
Modifier and Type Method Description abstract ListProperty<String>
getKaptClasspathConfigurationNames()
The names of Gradle's org.gradle.api.artifacts.Configuration that contains all the annotation processor artifacts used to configure kaptClasspath. abstract DirectoryProperty
getIncAptCache()
The output directory containing the caches necessary to support incremental annotation processing. abstract DirectoryProperty
getClassesDir()
The directory where class files generated by annotation processing can be found. abstract DirectoryProperty
getDestinationDir()
The directory where Java source files generated by annotation processing can be found. abstract DirectoryProperty
getKotlinSourcesDestinationDir()
The directory where Java source files generated by annotation processing can be found. abstract List<Object>
getAnnotationProcessorOptionProviders()
Represents a list of annotation processor option providers. abstract DirectoryProperty
getStubsDir()
The directory where the generated related KaptGenerateStubs task stub can be found. abstract ConfigurableFileCollection
getKaptClasspath()
Allows adding artifacts (usually JAR files) that contain the implementation of the Java annotation processor. abstract ConfigurableFileCollection
getCompiledSources()
The directory that contains the compiled related KotlinJvmCompile task classes. abstract ConfigurableFileCollection
getClasspath()
Contains all artifacts from the related KotlinJvmCompile.libraries task input. abstract Property<String>
getSourceSetName()
Specifies the name of org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet for which task is doing annotation processing. abstract ConfigurableFileCollection
getSource()
Contains all Java source code used in this compilation and generated by related KaptGenerateStubs task stubs. abstract Property<Boolean>
getIncludeCompileClasspath()
Enable searching for annotation processors in the classpath. abstract Property<String>
getDefaultJavaSourceCompatibility()
Java source compatibility in the form of the Java language level for the produced class files and Java source code. -
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 org.jetbrains.kotlin.gradle.tasks.UsesKotlinJavaToolchain
getKotlinJavaToolchain, getKotlinJavaToolchainProvider
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getKaptClasspathConfigurationNames
@Internal() abstract ListProperty<String> getKaptClasspathConfigurationNames()
The names of Gradle's org.gradle.api.artifacts.Configuration that contains all the annotation processor artifacts used to configure kaptClasspath.
-
getIncAptCache
@LocalState() abstract DirectoryProperty getIncAptCache()
The output directory containing the caches necessary to support incremental annotation processing.
-
getClassesDir
@OutputDirectory() abstract DirectoryProperty getClassesDir()
The directory where class files generated by annotation processing can be found.
-
getDestinationDir
@OutputDirectory() abstract DirectoryProperty getDestinationDir()
The directory where Java source files generated by annotation processing can be found.
-
getKotlinSourcesDestinationDir
@OutputDirectory() abstract DirectoryProperty getKotlinSourcesDestinationDir()
The directory where Java source files generated by annotation processing can be found.
-
getAnnotationProcessorOptionProviders
abstract List<Object> getAnnotationProcessorOptionProviders()
Represents a list of annotation processor option providers.
Accepts a List of org.gradle.process.CommandLineArgumentProviders.
-
getStubsDir
@Internal() abstract DirectoryProperty getStubsDir()
The directory where the generated related KaptGenerateStubs task stub can be found.
-
getKaptClasspath
@Classpath() abstract ConfigurableFileCollection getKaptClasspath()
Allows adding artifacts (usually JAR files) that contain the implementation of the Java annotation processor.
Should be configured with the same artifacts as in the related KaptGenerateStubs task.
-
getCompiledSources
@Internal() abstract ConfigurableFileCollection getCompiledSources()
The directory that contains the compiled related KotlinJvmCompile task classes.
-
getClasspath
@Internal(value = "Task implementation adds correct input annotation.") abstract ConfigurableFileCollection getClasspath()
Contains all artifacts from the related KotlinJvmCompile.libraries task input.
-
getSourceSetName
@Internal() abstract Property<String> getSourceSetName()
Specifies the name of org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet for which task is doing annotation processing.
-
getSource
@InputFiles()@IgnoreEmptyDirectories()@Incremental()@NormalizeLineEndings()@PathSensitive(value = PathSensitivity.RELATIVE) abstract ConfigurableFileCollection getSource()
Contains all Java source code used in this compilation and generated by related KaptGenerateStubs task stubs.
-
getIncludeCompileClasspath
@Input() abstract Property<Boolean> getIncludeCompileClasspath()
Enable searching for annotation processors in the classpath.
-
getDefaultJavaSourceCompatibility
@Internal(value = "Used to compute javac option.") abstract Property<String> getDefaultJavaSourceCompatibility()
Java source compatibility in the form of the Java language level for the produced class files and Java source code.
Check the
javac
-source
command line option description for the possible values for the Java language level.
-
-
-
-