com.android.build.gradle.tasks

Class ExtractAnnotations

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.gradle.api.tasks.compile.AbstractCompile

com.android.build.gradle.internal.tasks.AbstractAndroidCompile

com.android.build.gradle.tasks.ExtractAnnotations

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public class ExtractAnnotations
extends com.android.build.gradle.internal.tasks.AbstractAndroidCompile

Task which extracts annotations from the source files, and writes them to one of two possible destinations:

• A "external annotations" file (pointed to by output) which records the annotations in a zipped XML format for use by the IDE and by lint to associate the (source retention) annotations back with the compiled code

We typically only extract external annotations when building libraries; ProGuard annotations are extracted when building libraries (to record in the AAR), or when building an app module where ProGuarding is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtractAnnotations.ConfigAction

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from class org.gradle.api.tasks.SourceTask

source

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
ExtractAnnotations()

Method Summary

Modifier and Type	Method and Description
protected void	compile()
java.util.List<java.lang.String>	getBootClasspath() Boot classpath: typically android.jar
com.android.build.api.artifact.BuildableArtifact	getClassDir() Location of class files.
java.lang.String	getEncoding() The encoding to use when reading source files.
org.gradle.api.file.FileCollection	getLibraries()
org.gradle.api.file.FileCollection	getLintClassPath() Lint classpath
java.io.File	getOutput() The output .zip file to write the annotations database to, if any
org.gradle.api.file.FileTree	getSource()
java.io.File	getTypedefFile() The output .txt file to write the typedef recipe file to.
boolean	hasAndroidAnnotations()
void	setBootClasspath(java.util.function.Supplier<java.util.List<java.lang.String>> bootClasspath)
void	setClassDir(com.android.build.api.artifact.BuildableArtifact classDir)
void	setEncoding(java.lang.String encoding)
void	setOutput(java.io.File output)

Methods inherited from class org.gradle.api.tasks.compile.AbstractCompile

getClasspath, getDestinationDir, getSourceCompatibility, getTargetCompatibility, setClasspath, setDestinationDir, setDestinationDir, setSourceCompatibility, setTargetCompatibility

Methods inherited from class org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.DefaultTask

newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractAnnotations

public ExtractAnnotations()

Method Detail

getLintClassPath

@InputFiles
 @Nullable
public org.gradle.api.file.FileCollection getLintClassPath()

Lint classpath

getSource

@NonNull
 @PathSensitive(value=NAME_ONLY)
 @InputFiles
 @SkipWhenEmpty
public org.gradle.api.file.FileTree getSource()

Overrides:

getSource in class org.gradle.api.tasks.SourceTask

getBootClasspath

@CompileClasspath
public java.util.List<java.lang.String> getBootClasspath()

Boot classpath: typically android.jar

setBootClasspath

public void setBootClasspath(java.util.function.Supplier<java.util.List<java.lang.String>> bootClasspath)

getLibraries

@CompileClasspath
public org.gradle.api.file.FileCollection getLibraries()

getOutput

@OutputFile
public java.io.File getOutput()

The output .zip file to write the annotations database to, if any

setOutput

public void setOutput(java.io.File output)

getTypedefFile

@OutputFile
public java.io.File getTypedefFile()

The output .txt file to write the typedef recipe file to. A "recipe" file is a file which describes typedef classes, typically ones that should be deleted. It is generated by this ExtractAnnotations task and consumed by the TypedefRemover.

getEncoding

@NonNull
 @Input
public java.lang.String getEncoding()

The encoding to use when reading source files. The output file will ignore this and will always be a UTF-8 encoded .xml file inside the annotations zip file.

setEncoding

public void setEncoding(java.lang.String encoding)

getClassDir

@Optional
 @InputFiles
 @PathSensitive(value=RELATIVE)
public com.android.build.api.artifact.BuildableArtifact getClassDir()

Location of class files. If set, any non-public typedef source retention annotations will be removed prior to .jar packaging.

setClassDir

public void setClassDir(com.android.build.api.artifact.BuildableArtifact classDir)

compile

protected void compile()

Specified by:

compile in class org.gradle.api.tasks.compile.AbstractCompile

hasAndroidAnnotations

@Input
public boolean hasAndroidAnnotations()