com.android.ide.common.gradle.model

Class IdeAndroidProjectImpl

java.lang.Object

com.android.ide.common.gradle.model.IdeModel

com.android.ide.common.gradle.model.IdeAndroidProjectImpl

All Implemented Interfaces:

IdeAndroidProject, java.io.Serializable

public final class IdeAndroidProjectImpl
extends IdeModel
implements IdeAndroidProject

Creates a deep copy of an AndroidProject.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.android.ide.common.gradle.model.IdeAndroidProject

PROJECT_TYPE_APP, PROJECT_TYPE_ATOM, PROJECT_TYPE_DYNAMIC_FEATURE, PROJECT_TYPE_FEATURE, PROJECT_TYPE_INSTANTAPP, PROJECT_TYPE_LIBRARY, PROJECT_TYPE_TEST

Constructor Summary

Constructors

Constructor and Description
IdeAndroidProjectImpl(com.android.builder.model.AndroidProject project, IdeDependenciesFactory dependenciesFactory, java.util.Collection<com.android.builder.model.Variant> variants, com.android.builder.model.ProjectSyncIssues syncIssues)

Method Summary

Modifier and Type	Method and Description
void	addSyncIssues(java.util.Collection<com.android.builder.model.SyncIssue> syncIssues) Add sync issues from Variant-Only Sync.
void	addVariants(java.util.Collection<com.android.builder.model.Variant> variants, IdeDependenciesFactory factory) Add variant models obtained from Variant-Only Sync.
boolean	equals(java.lang.Object o)
void	forEachVariant(java.util.function.Consumer<IdeVariant> action)
com.android.builder.model.AaptOptions	getAaptOptions() Returns the aapt options.
int	getApiVersion() Returns the model api version.
java.util.Collection<java.lang.String>	getBootClasspath() Returns the boot classpath matching the compile target.
java.io.File	getBuildFolder() Returns the build folder of this project.
java.lang.String	getBuildToolsVersion() Returns the build tools version used by this module.
java.util.Collection<com.android.builder.model.BuildTypeContainer>	getBuildTypes() Returns a list of all the BuildType in their container.
java.lang.String	getCompileTarget() Returns the compilation target as a string.
com.android.builder.model.ProductFlavorContainer	getDefaultConfig() Returns the ProductFlavorContainer for the 'main' default config.
java.lang.String	getDefaultVariant() Returns the name of the variant the IDE should use when opening the project for the first time.
java.util.Collection<java.lang.String>	getDynamicFeatures() Returns the list of dynamic features.
java.util.Collection<java.lang.String>	getFlavorDimensions() Returns a list of all the flavor dimensions, may be empty.
com.android.builder.model.JavaCompileOptions	getJavaCompileOptions() Returns the compile options for Java code.
com.android.ide.common.gradle.model.IdeLintOptions	getLintOptions() Returns the lint options.
java.lang.String	getModelVersion() Returns the model version.
java.lang.String	getName() Returns the name of the module.
GradleVersion	getParsedModelVersion()
java.util.Collection<com.android.builder.model.ProductFlavorContainer>	getProductFlavors() Returns a list of all the ProductFlavor in their container.
int	getProjectType() Returns the type of project: Android application, library, feature, instantApp.
java.lang.String	getResourcePrefix() Returns the resource prefix to use, if any.
java.util.Collection<com.android.builder.model.SigningConfig>	getSigningConfigs() Returns a list of SigningConfig.
java.util.Collection<com.android.builder.model.SyncIssue>	getSyncIssues() Returns issues found during sync.
java.util.Collection<java.lang.String>	getUnresolvedDependencies() Deprecated.
java.util.Collection<java.lang.String>	getVariantNames() Returns a list of all the variant names.
java.util.Collection<com.android.builder.model.Variant>	getVariants() Returns a list of all the variants.
com.android.builder.model.ViewBindingOptions	getViewBindingOptions()
int	hashCode()
boolean	isBaseSplit() Returns true if this is the base feature split.
java.lang.String	toString()

Methods inherited from class com.android.ide.common.gradle.model.IdeModel

copy, copy, copy, copy, copyNewProperty, copyNewProperty, copyNewPropertyWithDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IdeAndroidProjectImpl

public IdeAndroidProjectImpl(@NonNull
                             com.android.builder.model.AndroidProject project,
                             @NonNull
                             IdeDependenciesFactory dependenciesFactory,
                             @Nullable
                             java.util.Collection<com.android.builder.model.Variant> variants,
                             @Nullable
                             com.android.builder.model.ProjectSyncIssues syncIssues)

Method Detail

getParsedModelVersion

@Nullable
public GradleVersion getParsedModelVersion()

Specified by:

getParsedModelVersion in interface IdeAndroidProject

getModelVersion

@NonNull
public java.lang.String getModelVersion()

Description copied from interface: IdeAndroidProject

Returns the model version. This is a string in the format X.Y.Z

Specified by:

getModelVersion in interface IdeAndroidProject

Returns:

a string containing the model version.

getName

@NonNull
public java.lang.String getName()

Description copied from interface: IdeAndroidProject

Returns the name of the module.

Specified by:

getName in interface IdeAndroidProject

Returns:

the name of the module.

getDefaultConfig

@NonNull
public com.android.builder.model.ProductFlavorContainer getDefaultConfig()

Description copied from interface: IdeAndroidProject

Returns the ProductFlavorContainer for the 'main' default config.

Specified by:

getDefaultConfig in interface IdeAndroidProject

Returns:

the product flavor.

getBuildTypes

@NonNull
public java.util.Collection<com.android.builder.model.BuildTypeContainer> getBuildTypes()

Description copied from interface: IdeAndroidProject

Returns a list of all the BuildType in their container.

Specified by:

getBuildTypes in interface IdeAndroidProject

Returns:

a list of build type containers.

getProductFlavors

@NonNull
public java.util.Collection<com.android.builder.model.ProductFlavorContainer> getProductFlavors()

Description copied from interface: IdeAndroidProject

Returns a list of all the ProductFlavor in their container.

Specified by:

getProductFlavors in interface IdeAndroidProject

Returns:

a list of product flavor containers.

getBuildToolsVersion

@NonNull
public java.lang.String getBuildToolsVersion()

Description copied from interface: IdeAndroidProject

Returns the build tools version used by this module.

Specified by:

getBuildToolsVersion in interface IdeAndroidProject

Returns:

the build tools version.

getSyncIssues

@NonNull
public java.util.Collection<com.android.builder.model.SyncIssue> getSyncIssues()

Description copied from interface: IdeAndroidProject

Returns issues found during sync. The returned list gets populated only if the system property AndroidProject.PROPERTY_BUILD_MODEL_ONLY has been set to true.

Specified by:

getSyncIssues in interface IdeAndroidProject

getVariants

@NonNull
public java.util.Collection<com.android.builder.model.Variant> getVariants()

Description copied from interface: IdeAndroidProject

Returns a list of all the variants.

This does not include test variant. Test variants are additional artifacts in their respective variant info.

Specified by:

getVariants in interface IdeAndroidProject

Returns:

a list of the variants.

getVariantNames

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

Description copied from interface: IdeAndroidProject

Returns a list of all the variant names.

This does not include test variant. Test variants are additional artifacts in their respective variant info.

Specified by:

getVariantNames in interface IdeAndroidProject

Returns:

a list of all the variant names.

getDefaultVariant

@Nullable
public java.lang.String getDefaultVariant()

Description copied from interface: IdeAndroidProject

Returns the name of the variant the IDE should use when opening the project for the first time.

Specified by:

getDefaultVariant in interface IdeAndroidProject

Returns:

the name of a variant that exists under the presence of the variant filter. Only returns null if all variants are removed.

getFlavorDimensions

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

Description copied from interface: IdeAndroidProject

Returns a list of all the flavor dimensions, may be empty.

Specified by:

getFlavorDimensions in interface IdeAndroidProject

Returns:

a list of the flavor dimensions.

getCompileTarget

@NonNull
public java.lang.String getCompileTarget()

Description copied from interface: IdeAndroidProject

Returns the compilation target as a string. This is the full extended target hash string. (see com.android.sdklib.IAndroidTarget#hashString())

Specified by:

getCompileTarget in interface IdeAndroidProject

Returns:

the target hash string

getBootClasspath

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

Description copied from interface: IdeAndroidProject

Returns the boot classpath matching the compile target. This is typically android.jar plus other optional libraries.

Specified by:

getBootClasspath in interface IdeAndroidProject

Returns:

a list of jar files.

getAaptOptions

@NonNull
public com.android.builder.model.AaptOptions getAaptOptions()

Description copied from interface: IdeAndroidProject

Returns the aapt options.

Specified by:

getAaptOptions in interface IdeAndroidProject

getSigningConfigs

@NonNull
public java.util.Collection<com.android.builder.model.SigningConfig> getSigningConfigs()

Description copied from interface: IdeAndroidProject

Returns a list of SigningConfig.

Specified by:

getSigningConfigs in interface IdeAndroidProject

getLintOptions

@NonNull
public com.android.ide.common.gradle.model.IdeLintOptions getLintOptions()

Description copied from interface: IdeAndroidProject

Returns the lint options.

Specified by:

getLintOptions in interface IdeAndroidProject

getUnresolvedDependencies

@Deprecated
 @NonNull
public java.util.Collection<java.lang.String> getUnresolvedDependencies()

Deprecated.

Description copied from interface: IdeAndroidProject

Returns the dependencies that were not successfully resolved. The returned list gets populated only if the system property AndroidProject.PROPERTY_BUILD_MODEL_ONLY has been set to true.

Each value of the collection has the format group:name:version, for example: com.google.guava:guava:15.0.2

Specified by:

getUnresolvedDependencies in interface IdeAndroidProject

Returns:

the dependencies that were not successfully resolved.

getJavaCompileOptions

@NonNull
public com.android.builder.model.JavaCompileOptions getJavaCompileOptions()

Description copied from interface: IdeAndroidProject

Returns the compile options for Java code.

Specified by:

getJavaCompileOptions in interface IdeAndroidProject

getBuildFolder

@NonNull
public java.io.File getBuildFolder()

Description copied from interface: IdeAndroidProject

Returns the build folder of this project.

Specified by:

getBuildFolder in interface IdeAndroidProject

getResourcePrefix

@Nullable
public java.lang.String getResourcePrefix()

Description copied from interface: IdeAndroidProject

Returns the resource prefix to use, if any. This is an optional prefix which can be set and which is used by the defaults to automatically choose new resources with a certain prefix, warn if resources are not using the given prefix, etc. This helps work with resources in the app namespace where there could otherwise be unintentional duplicated resource names between unrelated libraries.

Specified by:

getResourcePrefix in interface IdeAndroidProject

Returns:

the optional resource prefix, or null if not set

getApiVersion

public int getApiVersion()

Description copied from interface: IdeAndroidProject

Returns the model api version.

This is different from IdeAndroidProject.getModelVersion() in a way that new model version might increment model version but keep existing api. That means that code which was built against particular 'api version' might be safely re-used for all new model versions as long as they don't change the api.

Every new model version is assumed to return an 'api version' value which is equal or greater than the value used by the previous model version.

Specified by:

getApiVersion in interface IdeAndroidProject

Returns:

model's api version

getProjectType

public int getProjectType()

Description copied from interface: IdeAndroidProject

Returns the type of project: Android application, library, feature, instantApp.

Specified by:

getProjectType in interface IdeAndroidProject

Returns:

the type of project.

isBaseSplit

public boolean isBaseSplit()

Description copied from interface: IdeAndroidProject

Returns true if this is the base feature split.

Specified by:

isBaseSplit in interface IdeAndroidProject

Returns:

true if this is the base feature split

getDynamicFeatures

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

Description copied from interface: IdeAndroidProject

Returns the list of dynamic features.

The values are Gradle path. Only valid for base splits.

Specified by:

getDynamicFeatures in interface IdeAndroidProject

Returns:

getViewBindingOptions

@Nullable
public com.android.builder.model.ViewBindingOptions getViewBindingOptions()

Specified by:

getViewBindingOptions in interface IdeAndroidProject

forEachVariant

public void forEachVariant(@NonNull
                           java.util.function.Consumer<IdeVariant> action)

Specified by:

forEachVariant in interface IdeAndroidProject

addVariants

public void addVariants(@NonNull
                        java.util.Collection<com.android.builder.model.Variant> variants,
                        @NonNull
                        IdeDependenciesFactory factory)

Description copied from interface: IdeAndroidProject

Add variant models obtained from Variant-Only Sync.

Specified by:

addVariants in interface IdeAndroidProject

Parameters:

variants - List of Variant models obtained by Variant-Only Sync.

factory - IdeDependenciesFactory that handles GlobalLibraryMap for DependencyGraph.

addSyncIssues

public void addSyncIssues(@NonNull
                          java.util.Collection<com.android.builder.model.SyncIssue> syncIssues)

Description copied from interface: IdeAndroidProject

Add sync issues from Variant-Only Sync.

Specified by:

addSyncIssues in interface IdeAndroidProject

Parameters:

syncIssues - List of SyncIssue from the AndroidProject model obtained by Variant-Only Sync.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object