com.android.build.gradle.AndroidGradleOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-core Show documentation
Show all versions of gradle-core Show documentation
Core library to build Android Gradle plugin.
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.build.gradle;
import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.builder.model.AndroidProject;
import com.android.sdklib.AndroidVersion;
import com.google.common.collect.Maps;
import org.gradle.api.Project;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
/**
* Determines if various options, triggered from the command line or environment, are set.
*/
public class AndroidGradleOptions {
private static final String PROPERTY_TEST_RUNNER_ARGS =
"android.testInstrumentationRunnerArguments.";
private static final String PROPERTY_THREAD_POOL_SIZE = "android.threadPoolSize";
private static final String PROPERTY_THREAD_POOL_SIZE_OLD = "com.android.build.threadPoolSize";
public static final String USE_DEPRECATED_NDK = "android.useDeprecatedNdk";
private static final String PROPERTY_DISABLE_RESOURCE_VALIDATION =
"android.disableResourceValidation";
// TODO: Drop the "com." prefix, for consistency.
private static final String PROPERTY_BENCHMARK_NAME = "com.android.benchmark.name";
private static final String PROPERTY_BENCHMARK_MODE = "com.android.benchmark.mode";
public static final String PROPERTY_INCREMENTAL_JAVA_COMPILE =
"android.incrementalJavaCompile";
private static final String PROPERTY_USE_OLD_PACKAGING = "android.useOldPackaging";
@NonNull
public static Map getExtraInstrumentationTestRunnerArgs(@NonNull Project project) {
Map argsMap = Maps.newHashMap();
for (Map.Entry entry : project.getProperties().entrySet()) {
if (entry.getKey().startsWith(PROPERTY_TEST_RUNNER_ARGS)) {
String argName = entry.getKey().substring(PROPERTY_TEST_RUNNER_ARGS.length());
String argValue = entry.getValue().toString();
argsMap.put(argName, argValue);
}
}
return argsMap;
}
@Nullable
public static String getBenchmarkName(@NonNull Project project) {
return getString(project, PROPERTY_BENCHMARK_NAME);
}
@Nullable
public static String getBenchmarkMode(@NonNull Project project) {
return getString(project, PROPERTY_BENCHMARK_MODE);
}
public static boolean invokedFromIde(@NonNull Project project) {
return getBoolean(project, AndroidProject.PROPERTY_INVOKED_FROM_IDE);
}
public static boolean buildModelOnly(@NonNull Project project) {
return getBoolean(project, AndroidProject.PROPERTY_BUILD_MODEL_ONLY);
}
public static boolean buildModelOnlyAdvanced(@NonNull Project project) {
return getBoolean(project, AndroidProject.PROPERTY_BUILD_MODEL_ONLY_ADVANCED);
}
public static boolean useOldPackaging(@NonNull Project project) {
return getBoolean(project, PROPERTY_USE_OLD_PACKAGING, true);
}
@Nullable
public static String getApkLocation(@NonNull Project project) {
return getString(project, AndroidProject.PROPERTY_APK_LOCATION);
}
@Nullable
public static String getBuildTargetDensity(@NonNull Project project) {
return getString(project, AndroidProject.PROPERTY_BUILD_DENSITY);
}
@Nullable
public static String getBuildTargetAbi(@NonNull Project project) {
return getString(project, AndroidProject.PROPERTY_BUILD_ABI);
}
/**
* Returns the {@link AndroidVersion} for the target device.
*
* @param project the project being built
* @return a {@link AndroidVersion} for the targeted device, following the
* {@link AndroidProject#PROPERTY_BUILD_API} value passed by Android Studio.
*/
@NonNull
public static AndroidVersion getTargetApiLevel(@NonNull Project project) {
String apiVersion = getString(project, AndroidProject.PROPERTY_BUILD_API);
AndroidVersion version = AndroidVersion.DEFAULT;
if (apiVersion != null) {
try {
version = new AndroidVersion(apiVersion);
} catch (AndroidVersion.AndroidVersionException e) {
project.getLogger().warn("Wrong build target version passed ", e);
}
}
return version;
}
@Nullable
public static String getColdswapMode(@NonNull Project project) {
return getString(project, AndroidProject.PROPERTY_SIGNING_COLDSWAP_MODE);
}
public static boolean useDeprecatedNdk(@NonNull Project project) {
return getBoolean(project, USE_DEPRECATED_NDK);
}
@Nullable
public static Integer getThreadPoolSize(@NonNull Project project) {
Integer size = getInteger(project, PROPERTY_THREAD_POOL_SIZE);
if (size == null) {
size = getInteger(project, PROPERTY_THREAD_POOL_SIZE_OLD);
}
return size;
}
@Nullable
public static SigningOptions getSigningOptions(@NonNull Project project) {
String signingStoreFile =
getString(project, AndroidProject.PROPERTY_SIGNING_STORE_FILE);
String signingStorePassword =
getString(project, AndroidProject.PROPERTY_SIGNING_STORE_PASSWORD);
String signingKeyAlias =
getString(project, AndroidProject.PROPERTY_SIGNING_KEY_ALIAS);
String signingKeyPassword =
getString(project, AndroidProject.PROPERTY_SIGNING_KEY_PASSWORD);
if (signingStoreFile != null
&& signingStorePassword != null
&& signingKeyAlias != null
&& signingKeyPassword != null) {
String signingStoreType =
getString(project, AndroidProject.PROPERTY_SIGNING_STORE_TYPE);
return new SigningOptions(
signingStoreFile,
signingStorePassword,
signingKeyAlias,
signingKeyPassword,
signingStoreType);
}
return null;
}
@NonNull
public static EnumSet getOptionalCompilationSteps(
@NonNull Project project) {
String values = getString(project, AndroidProject.OPTIONAL_COMPILATION_STEPS);
if (values != null) {
List optionalCompilationSteps =
new ArrayList();
StringTokenizer st = new StringTokenizer(values, ",");
while(st.hasMoreElements()) {
optionalCompilationSteps.add(OptionalCompilationStep.valueOf(st.nextToken()));
}
return EnumSet.copyOf(optionalCompilationSteps);
}
return EnumSet.noneOf(OptionalCompilationStep.class);
}
public static boolean isResourceValidationEnabled(@NonNull Project project) {
return !getBoolean(project, PROPERTY_DISABLE_RESOURCE_VALIDATION);
}
@Nullable
private static String getString(@NonNull Project project, String propertyName) {
return project.hasProperty(propertyName) ? (String) project.property(propertyName) : null;
}
@Nullable
private static Integer getInteger(@NonNull Project project, String propertyName) {
if (project.hasProperty(propertyName)) {
try {
return Integer.parseInt(project.property(propertyName).toString());
} catch (NumberFormatException e) {
throw new RuntimeException("Property " + propertyName + " needs to be an integer.");
}
}
return null;
}
private static boolean getBoolean(
@NonNull Project project,
@NonNull String propertyName) {
return getBoolean(project, propertyName, false /*defaultValue*/);
}
private static boolean getBoolean(
@NonNull Project project,
@NonNull String propertyName,
boolean defaultValue) {
if (project.hasProperty(propertyName)) {
Object value = project.property(propertyName);
if (value instanceof String) {
return Boolean.parseBoolean((String) value);
} else if (value instanceof Boolean) {
return ((Boolean) value);
}
}
return defaultValue;
}
public static boolean isJavaCompileIncrementalPropertySet(@NonNull Project project) {
return project.hasProperty(PROPERTY_INCREMENTAL_JAVA_COMPILE);
}
public static class SigningOptions {
@NonNull public final String storeFile;
@NonNull public final String storePassword;
@NonNull public final String keyAlias;
@NonNull public final String keyPassword;
@Nullable public final String storeType;
SigningOptions(
@NonNull String storeFile,
@NonNull String storePassword,
@NonNull String keyAlias,
@NonNull String keyPassword,
@Nullable String storeType) {
this.storeFile = storeFile;
this.storeType = storeType;
this.storePassword = storePassword;
this.keyAlias = keyAlias;
this.keyPassword = keyPassword;
}
}
}