How do I know the properties in applicationVariants of android gradle plugin?-ThrowExceptions

Exception or error:

I’m using Android Studio with gradle plugin to develop applications. I learn some usage of android gradle plugin on DSL Reference. But one thing I found is that the applicationVariants part on doc is hard to understand. It only gives such a description:

DomainObjectSet<ApplicationVariant> applicationVariants

The list of Application variants. Since the collections is built after evaluation, it should be used with Gradle’s all iterator to process future items.

But what’s the properties in the ApplicationVariant? I don’t know. And I found nothing reference link to describe the ApplicationVariant.

Only in the Gradle Plugin User Guide at the very bottom of the page. It documents the available properties in applicationVariants, libraryVariants and testVariants. But I found quite some of these properties are deprecated for a long time, and Android didn’t update this page.

So where do I find the most updated properties in ApplicationVariant?

How to solve:

https://android.googlesource.com/platform/tools/build/+/8dca86a/gradle/src/main/groovy/com/android/build/gradle/internal/ApplicationVariant.groovy

I had a hard time finding it too. Here’s the interface incase it moves:
It will also have any props you define in your flavor, like the versionName, applicationId etc

public interface ApplicationVariant {
    String getName()
    String getDescription()
    String getDirName()
    String getBaseName()
    VariantConfiguration getConfig()
    boolean getZipAlign()
    boolean isSigned()
    boolean getRunProguard()
    FileCollection getRuntimeClasspath()
    FileCollection getResourcePackage()
    Compile getCompileTask()
    List<String> getRunCommand()
    String getPackage()
    AndroidBuilder createBuilder(AndroidBasePlugin androidBasePlugin)
}

And to print the props of any object:

def filtered = ['class', 'active']

println theObject.properties
            .sort{it.key}
            .collect{it}
            .findAll{!filtered.contains(it.key)}
            .join('\n')

###

The link in @CaptRespect’s answer is to a specific build. Here are the links to the public API in the master branch:

/gradle/api/ApplicationVariant.java
(derives from)
/gradle/api/ApkVariant.java
(derives from)
/gradle/api/BaseVariant.java

###

Here’s some documentation on those:

Leave a Reply

Your email address will not be published. Required fields are marked *