com.android.ide.common.gradle.model

Interface IdeAndroidProject

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IdeAndroidProjectImpl

public interface IdeAndroidProject
extends java.io.Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROJECT_TYPE_APP
static int	PROJECT_TYPE_ATOM Deprecated.
static int	PROJECT_TYPE_DYNAMIC_FEATURE
static int	PROJECT_TYPE_FEATURE
static int	PROJECT_TYPE_INSTANTAPP
static int	PROJECT_TYPE_LIBRARY
static int	PROJECT_TYPE_TEST

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.
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. use getSyncIssues()
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()
boolean	isBaseSplit() Returns true if this is the base feature split.

Field Detail

PROJECT_TYPE_APP

static final int PROJECT_TYPE_APP

See Also:

Constant Field Values

PROJECT_TYPE_LIBRARY

static final int PROJECT_TYPE_LIBRARY

See Also:

Constant Field Values

PROJECT_TYPE_TEST

static final int PROJECT_TYPE_TEST

See Also:

Constant Field Values

PROJECT_TYPE_ATOM

@Deprecated
static final int PROJECT_TYPE_ATOM

Deprecated.

See Also:

Constant Field Values

PROJECT_TYPE_INSTANTAPP

static final int PROJECT_TYPE_INSTANTAPP

See Also:

Constant Field Values

PROJECT_TYPE_FEATURE

static final int PROJECT_TYPE_FEATURE

See Also:

Constant Field Values

PROJECT_TYPE_DYNAMIC_FEATURE

static final int PROJECT_TYPE_DYNAMIC_FEATURE

See Also:

Constant Field Values

Method Detail

getModelVersion

@NonNull
java.lang.String getModelVersion()

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

Returns:

a string containing the model version.

getApiVersion

int getApiVersion()

Returns the model api version.

This is different from 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.

Returns:

model's api version

getName

@NonNull
java.lang.String getName()

Returns the name of the module.

Returns:

the name of the module.

getProjectType

int getProjectType()

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

Returns:

the type of project.

Since:

2.3

getDefaultConfig

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

Returns the ProductFlavorContainer for the 'main' default config.

Returns:

the product flavor.

getBuildTypes

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

Returns a list of all the BuildType in their container.

Returns:

a list of build type containers.

getProductFlavors

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

Returns a list of all the ProductFlavor in their container.

Returns:

a list of product flavor containers.

getVariants

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

Returns a list of all the variants.

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

Returns:

a list of the variants.

getVariantNames

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

Returns a list of all the variant names.

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

Returns:

a list of all the variant names.

Since:

3.2.

getDefaultVariant

@Nullable
java.lang.String getDefaultVariant()

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

Returns:

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

Since:

3.5

getFlavorDimensions

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

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

Returns:

a list of the flavor dimensions.

getCompileTarget

@NonNull
java.lang.String getCompileTarget()

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

Returns:

the target hash string

getBootClasspath

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

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

Returns:

a list of jar files.

getSigningConfigs

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

Returns a list of SigningConfig.

getAaptOptions

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

Returns the aapt options.

getLintOptions

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

Returns the lint options.

getUnresolvedDependencies

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

Deprecated. use getSyncIssues()

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

Returns:

the dependencies that were not successfully resolved.

getSyncIssues

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

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.

getJavaCompileOptions

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

Returns the compile options for Java code.

getBuildFolder

@NonNull
java.io.File getBuildFolder()

Returns the build folder of this project.

getResourcePrefix

@Nullable
java.lang.String getResourcePrefix()

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.

Returns:

the optional resource prefix, or null if not set

getBuildToolsVersion

@NonNull
java.lang.String getBuildToolsVersion()

Returns the build tools version used by this module.

Returns:

the build tools version.

isBaseSplit

boolean isBaseSplit()

Returns true if this is the base feature split.

Returns:

true if this is the base feature split

Since:

2.4

getDynamicFeatures

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

Returns the list of dynamic features.

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

Returns:

getViewBindingOptions

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

getParsedModelVersion

@Nullable
GradleVersion getParsedModelVersion()

forEachVariant

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

addVariants

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

Add variant models obtained from Variant-Only Sync.

Parameters:

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

factory - IdeDependenciesFactory that handles GlobalLibraryMap for DependencyGraph.

addSyncIssues

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

Add sync issues from Variant-Only Sync.

Parameters:

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