com.android.build.gradle.tasks

Class PackageAndroidArtifact

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.android.build.gradle.internal.tasks.AndroidVariantTask

com.android.build.gradle.internal.tasks.AndroidBuilderTask

com.android.build.gradle.internal.tasks.IncrementalTask

com.android.build.gradle.tasks.PackageAndroidArtifact

All Implemented Interfaces:

com.android.build.gradle.internal.tasks.VariantAwareTask, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

Direct Known Subclasses:

PackageApplication

public abstract class PackageAndroidArtifact
extends com.android.build.gradle.internal.tasks.IncrementalTask

Abstract task to package an Android artifact.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PackageAndroidArtifact.CreationAction<T extends PackageAndroidArtifact>

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

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<java.lang.String>	aaptOptionsNoCompress
protected com.android.build.gradle.internal.packaging.IncrementalPackagerBuilder.ApkFormat	apkFormat Desired output format.
protected com.android.build.api.artifact.BuildableArtifact	apkList
protected com.android.build.api.artifact.BuildableArtifact	assets
protected java.lang.String	buildTargetAbi
protected java.lang.String	buildTargetDensity
protected org.gradle.api.file.FileCollection	dexFolders
protected org.gradle.api.file.FileCollection	featureDexFolder
protected com.android.builder.utils.FileCache	fileCache
static java.lang.String	INSTANT_RUN_PACKAGES_PREFIX
protected java.util.function.Supplier<com.android.build.gradle.internal.incremental.InstantRunBuildContext>	instantRunContext
protected com.android.build.gradle.internal.incremental.FileType	instantRunFileType
protected org.gradle.api.file.FileCollection	javaResourceFiles list of folders and/or jars that contain the merged java resources.
protected org.gradle.api.file.FileCollection	jniFolders
protected com.android.build.api.artifact.BuildableArtifact	manifests
protected com.android.build.gradle.internal.scope.InternalArtifactType	manifestType
protected java.util.function.Supplier<com.android.sdklib.AndroidVersion>	minSdkVersion
protected java.io.File	outputDirectory
protected com.android.build.gradle.tasks.PackageAndroidArtifact.OutputFileProvider	outputFileProvider
protected com.android.build.gradle.internal.scope.OutputScope	outputScope
protected java.lang.String	projectBaseName
protected com.android.build.api.artifact.BuildableArtifact	resourceFiles

Fields inherited from class com.android.build.gradle.internal.tasks.IncrementalTask

MARKER_NAME

Fields inherited from class com.android.build.gradle.internal.tasks.AndroidVariantTask

variantName

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
PackageAndroidArtifact()

Method Summary

Modifier and Type	Method and Description
protected void	doFullTaskAction()
protected void	doIncrementalTaskAction(java.util.Map<java.io.File,com.android.ide.common.resources.FileStatus> changedInputs)
java.util.Set<java.lang.String>	getAbiFilters()
java.lang.String	getApkFormat()
com.android.build.api.artifact.BuildableArtifact	getApkList()
java.util.Collection<java.lang.String>	getApkNames() Returns the paths to generated APKs as @Input to this task, so that when the output file name is changed (e.g., by the users), the task will be re-executed in non-incremental mode.
com.android.build.api.artifact.BuildableArtifact	getAssets()
java.lang.String	getBuildTargetAbi()
java.lang.String	getBuildTargetDensity()
boolean	getDebugBuild()
org.gradle.api.file.FileCollection	getDexFolders()
org.gradle.api.file.FileCollection	getFeatureDexFolder()
protected abstract com.android.build.gradle.internal.scope.InternalArtifactType	getInternalArtifactType()
org.gradle.api.file.FileCollection	getJavaResourceFiles()
boolean	getJniDebugBuild()
org.gradle.api.file.FileCollection	getJniFolders()
com.android.build.api.artifact.BuildableArtifact	getManifests()
com.android.build.gradle.internal.scope.InternalArtifactType	getManifestType()
int	getMinSdkVersion()
java.util.List<java.lang.String>	getNativeLibrariesPackagingModeName()
java.util.Collection<java.lang.String>	getNoCompressExtensions()
java.io.File	getOutputDirectory()
java.lang.String	getProjectBaseName()
com.android.build.api.artifact.BuildableArtifact	getResourceFiles()
org.gradle.api.file.FileCollection	getSigningConfig() Retrieves the signing config file collection.
com.android.build.gradle.internal.scope.InternalArtifactType	getTaskInputType()
protected boolean	isIncremental()
java.lang.Boolean	isInInstantRunMode()
void	setAbiFilters(java.util.Set<java.lang.String> abiFilters)
void	setDebugBuild(boolean debugBuild)
void	setJniDebugBuild(boolean jniDebugBuild)
void	setSigningConfig(org.gradle.api.file.FileCollection signingConfig)
java.io.File	splitFullAction(com.android.ide.common.build.ApkInfo apkData, java.io.File processedResources)

Methods inherited from class com.android.build.gradle.internal.tasks.IncrementalTask

getIncrementalFolder, setIncrementalFolder

Methods inherited from class com.android.build.gradle.internal.tasks.AndroidBuilderTask

getBuilder, getBuildTools, getILogger, setAndroidBuilder

Methods inherited from class com.android.build.gradle.internal.tasks.AndroidVariantTask

getVariantName, setVariantName

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, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, 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

Field Detail

INSTANT_RUN_PACKAGES_PREFIX

public static final java.lang.String INSTANT_RUN_PACKAGES_PREFIX

See Also:

Constant Field Values

manifestType

protected com.android.build.gradle.internal.scope.InternalArtifactType manifestType

resourceFiles

protected com.android.build.api.artifact.BuildableArtifact resourceFiles

dexFolders

protected org.gradle.api.file.FileCollection dexFolders

featureDexFolder

@Nullable
protected org.gradle.api.file.FileCollection featureDexFolder

assets

protected com.android.build.api.artifact.BuildableArtifact assets

javaResourceFiles

protected org.gradle.api.file.FileCollection javaResourceFiles

list of folders and/or jars that contain the merged java resources.

jniFolders

protected org.gradle.api.file.FileCollection jniFolders

minSdkVersion

protected java.util.function.Supplier<com.android.sdklib.AndroidVersion> minSdkVersion

instantRunContext

protected java.util.function.Supplier<com.android.build.gradle.internal.incremental.InstantRunBuildContext> instantRunContext

manifests

protected com.android.build.api.artifact.BuildableArtifact manifests

aaptOptionsNoCompress

@Nullable
protected java.util.Collection<java.lang.String> aaptOptionsNoCompress

instantRunFileType

protected com.android.build.gradle.internal.incremental.FileType instantRunFileType

outputScope

protected com.android.build.gradle.internal.scope.OutputScope outputScope

projectBaseName

protected java.lang.String projectBaseName

buildTargetAbi

@Nullable
protected java.lang.String buildTargetAbi

buildTargetDensity

@Nullable
protected java.lang.String buildTargetDensity

outputDirectory

protected java.io.File outputDirectory

outputFileProvider

@Nullable
protected com.android.build.gradle.tasks.PackageAndroidArtifact.OutputFileProvider outputFileProvider

fileCache

protected com.android.builder.utils.FileCache fileCache

apkList

protected com.android.build.api.artifact.BuildableArtifact apkList

apkFormat

protected com.android.build.gradle.internal.packaging.IncrementalPackagerBuilder.ApkFormat apkFormat

Desired output format.

Constructor Detail

PackageAndroidArtifact

public PackageAndroidArtifact()

Method Detail

getManifests

@InputFiles
 @PathSensitive(value=ABSOLUTE)
public com.android.build.api.artifact.BuildableArtifact getManifests()

getResourceFiles

@InputFiles
 @PathSensitive(value=ABSOLUTE)
public com.android.build.api.artifact.BuildableArtifact getResourceFiles()

getAbiFilters

@Input
 @NonNull
public java.util.Set<java.lang.String> getAbiFilters()

setAbiFilters

public void setAbiFilters(@Nullable
                          java.util.Set<java.lang.String> abiFilters)

getManifestType

@Input
public com.android.build.gradle.internal.scope.InternalArtifactType getManifestType()

getJavaResourceFiles

@InputFiles
 @Optional
 @PathSensitive(value=ABSOLUTE)
public org.gradle.api.file.FileCollection getJavaResourceFiles()

getJniFolders

@InputFiles
 @Optional
 @PathSensitive(value=ABSOLUTE)
public org.gradle.api.file.FileCollection getJniFolders()

getDexFolders

@InputFiles
 @Optional
 @PathSensitive(value=ABSOLUTE)
public org.gradle.api.file.FileCollection getDexFolders()

getFeatureDexFolder

@InputFiles
 @Optional
 @Nullable
 @PathSensitive(value=ABSOLUTE)
public org.gradle.api.file.FileCollection getFeatureDexFolder()

getAssets

@InputFiles
 @PathSensitive(value=ABSOLUTE)
public com.android.build.api.artifact.BuildableArtifact getAssets()

getProjectBaseName

@Input
public java.lang.String getProjectBaseName()

getApkFormat

@Input
public java.lang.String getApkFormat()

getJniDebugBuild

@Input
public boolean getJniDebugBuild()

setJniDebugBuild

public void setJniDebugBuild(boolean jniDebugBuild)

getDebugBuild

@Input
public boolean getDebugBuild()

setDebugBuild

public void setDebugBuild(boolean debugBuild)

getSigningConfig

@InputFiles
 @Optional
public org.gradle.api.file.FileCollection getSigningConfig()

Retrieves the signing config file collection. It is necessary to make this an optional input for instant run packaging, which explicitly sets this to a null file collection.

setSigningConfig

public void setSigningConfig(org.gradle.api.file.FileCollection signingConfig)

getMinSdkVersion

@Input
public int getMinSdkVersion()

isInInstantRunMode

@Input
public java.lang.Boolean isInInstantRunMode()

getNativeLibrariesPackagingModeName

@Input
public java.util.List<java.lang.String> getNativeLibrariesPackagingModeName()

getNoCompressExtensions

@NonNull
 @Input
public java.util.Collection<java.lang.String> getNoCompressExtensions()

getTaskInputType

@Input
public com.android.build.gradle.internal.scope.InternalArtifactType getTaskInputType()

getBuildTargetAbi

@Input
 @Optional
 @Nullable
public java.lang.String getBuildTargetAbi()

getBuildTargetDensity

@Input
 @Optional
 @Nullable
public java.lang.String getBuildTargetDensity()

getOutputDirectory

@OutputDirectory
public java.io.File getOutputDirectory()

getApkNames

@Input
public java.util.Collection<java.lang.String> getApkNames()

Returns the paths to generated APKs as @Input to this task, so that when the output file name is changed (e.g., by the users), the task will be re-executed in non-incremental mode.

getApkList

@InputFiles
public com.android.build.api.artifact.BuildableArtifact getApkList()

getInternalArtifactType

protected abstract com.android.build.gradle.internal.scope.InternalArtifactType getInternalArtifactType()

doFullTaskAction

protected void doFullTaskAction()

Specified by:

doFullTaskAction in class com.android.build.gradle.internal.tasks.IncrementalTask

splitFullAction

public java.io.File splitFullAction(@NonNull
                                    com.android.ide.common.build.ApkInfo apkData,
                                    @Nullable
                                    java.io.File processedResources)
                             throws java.io.IOException

Throws:

java.io.IOException

isIncremental

protected boolean isIncremental()

Overrides:

isIncremental in class com.android.build.gradle.internal.tasks.IncrementalTask

doIncrementalTaskAction

protected void doIncrementalTaskAction(java.util.Map<java.io.File,com.android.ide.common.resources.FileStatus> changedInputs)

Overrides:

doIncrementalTaskAction in class com.android.build.gradle.internal.tasks.IncrementalTask