com.simpligility.maven.plugins.android.common

Class AaptCommandBuilder.AaptPackageCommandBuilder

java.lang.Object

com.simpligility.maven.plugins.android.common.AaptCommandBuilder

com.simpligility.maven.plugins.android.common.AaptCommandBuilder.AaptPackageCommandBuilder

Enclosing class:

AaptCommandBuilder

public static final class AaptCommandBuilder.AaptPackageCommandBuilder
extends AaptCommandBuilder

Class that responsible for building appt commands for packaging resources

Nested Class Summary

Nested classes/interfaces inherited from class com.simpligility.maven.plugins.android.common.AaptCommandBuilder

AaptCommandBuilder.AaptDumpCommandBuilder, AaptCommandBuilder.AaptPackageCommandBuilder

Field Summary

Fields inherited from class com.simpligility.maven.plugins.android.common.AaptCommandBuilder

commands, log

Constructor Summary

Constructors

Constructor and Description
AaptPackageCommandBuilder(org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method and Description
AaptCommandBuilder.AaptPackageCommandBuilder	addConfigurations(String configurations) Specify which configurations to include.
AaptCommandBuilder.AaptPackageCommandBuilder	addExistingPackageToBaseIncludeSet(File path) Add an existing package to base include set.
AaptCommandBuilder.AaptPackageCommandBuilder	addExtraArguments(String[] extraArguments) Adds some additional aapt arguments that are not represented as separate parameters android-maven-plugin configuration.
AaptCommandBuilder.AaptPackageCommandBuilder	addRawAssetsDirectoryIfExists(File assetsFolder) Additional directory in which to find raw asset files.
AaptCommandBuilder.AaptPackageCommandBuilder	addResourceDirectoriesIfExists(File[] resourceDirectories) Directories in which to find resources.
AaptCommandBuilder.AaptPackageCommandBuilder	addResourceDirectoriesIfExists(List<File> resourceDirectories) Directories in which to find resources.
AaptCommandBuilder.AaptPackageCommandBuilder	addResourceDirectoryIfExists(File resourceDirectory) Directory in which to find resources.
AaptCommandBuilder.AaptPackageCommandBuilder	autoAddOverlay() Automatically add resources that are only in overlays.
AaptCommandBuilder.AaptPackageCommandBuilder	disablePngCrunching() Disable PNG crunching.
AaptCommandBuilder.AaptPackageCommandBuilder	forceOverwriteExistingFiles() Force overwrite of existing files.
AaptCommandBuilder.AaptPackageCommandBuilder	generateRIntoPackage(String packageName) Generates R java into a different package.
AaptCommandBuilder.AaptPackageCommandBuilder	generateRTextFile(File folderForR) Generates a text file containing the resource symbols of the R class in the specified folder.
AaptCommandBuilder.AaptPackageCommandBuilder	makePackageDirectories() Make package directories under location specified by setResourceConstantsFolder(java.io.File).
AaptCommandBuilder.AaptPackageCommandBuilder	makeResourcesNonConstant() Make the resources ID non constant.
AaptCommandBuilder.AaptPackageCommandBuilder	makeResourcesNonConstant(boolean make) Make the resources ID non constant.
AaptCommandBuilder.AaptPackageCommandBuilder	renameInstrumentationTargetPackage(String instrumentationPackage) Rewrite the manifest so that all of its instrumentation components target the given package.
AaptCommandBuilder.AaptPackageCommandBuilder	renameManifestPackage(String manifestPackage) Rewrite the manifest so that its package name is the package name given here.
AaptCommandBuilder.AaptPackageCommandBuilder	setDebugMode(boolean isDebugMode) Inserts android:debuggable="true" into the application node of the manifest, making the application debuggable even on production devices.
AaptCommandBuilder.AaptPackageCommandBuilder	setOutputApkFile(File outputFile) Specify the apk file to output.
AaptCommandBuilder.AaptPackageCommandBuilder	setPathToAndroidManifest(File path) Specify full path to AndroidManifest.xml to include in zip.
AaptCommandBuilder.AaptPackageCommandBuilder	setProguardOptionsOutputFile(File outputFile) Output Proguard options to a File.
AaptCommandBuilder.AaptPackageCommandBuilder	setResourceConstantsFolder(File path) Specify where the R java resource constant definitions should be generated or found.
AaptCommandBuilder.AaptPackageCommandBuilder	setVerbose(boolean isVerbose) Makes output verbose.

Methods inherited from class com.simpligility.maven.plugins.android.common.AaptCommandBuilder

build, dump, packageResources, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AaptPackageCommandBuilder

public AaptPackageCommandBuilder(org.apache.maven.plugin.logging.Log log)

Method Detail

makeResourcesNonConstant

public AaptCommandBuilder.AaptPackageCommandBuilder makeResourcesNonConstant()

Make the resources ID non constant. This is required to make an R java class that does not contain the final value but is used to make reusable compiled libraries that need to access resources.

Returns:

current instance of AaptCommandBuilder.AaptPackageCommandBuilder

makeResourcesNonConstant

public AaptCommandBuilder.AaptPackageCommandBuilder makeResourcesNonConstant(boolean make)

Make the resources ID non constant. This is required to make an R java class that does not contain the final value but is used to make reusable compiled libraries that need to access resources.

Parameters:

make - if true make resources ID non constant, otherwise ignore

Returns:

current instance of AaptCommandBuilder.AaptPackageCommandBuilder

makePackageDirectories

public AaptCommandBuilder.AaptPackageCommandBuilder makePackageDirectories()

Make package directories under location specified by setResourceConstantsFolder(java.io.File).

Returns:

current instance of AaptCommandBuilder

setResourceConstantsFolder

public AaptCommandBuilder.AaptPackageCommandBuilder setResourceConstantsFolder(File path)

Specify where the R java resource constant definitions should be generated or found.

Parameters:

path - path to resource constants folder.

Returns:

current instance of AaptCommandBuilder

generateRIntoPackage

public AaptCommandBuilder.AaptPackageCommandBuilder generateRIntoPackage(String packageName)

Generates R java into a different package.

Parameters:

packageName - package name which generate R.java into

Returns:

current instance of AaptCommandBuilder

setPathToAndroidManifest

public AaptCommandBuilder.AaptPackageCommandBuilder setPathToAndroidManifest(File path)

Specify full path to AndroidManifest.xml to include in zip.

Parameters:

path - Path to AndroidManifest.xml

Returns:

current instance of AaptCommandBuilder

addResourceDirectoryIfExists

public AaptCommandBuilder.AaptPackageCommandBuilder addResourceDirectoryIfExists(File resourceDirectory)

Directory in which to find resources. Multiple directories will be scanned and the first match found (left to right) will take precedence.

Parameters:

resourceDirectory - resource directory File

Returns:

current instance of AaptCommandBuilder

addResourceDirectoriesIfExists

public AaptCommandBuilder.AaptPackageCommandBuilder addResourceDirectoriesIfExists(List<File> resourceDirectories)

Directories in which to find resources. Multiple directories will be scanned and the first match found (left to right) will take precedence.

Parameters:

resourceDirectories - List of resource directories File

Returns:

current instance of AaptCommandBuilder

addResourceDirectoriesIfExists

public AaptCommandBuilder.AaptPackageCommandBuilder addResourceDirectoriesIfExists(File[] resourceDirectories)

Directories in which to find resources. Multiple directories will be scanned and the first match found (left to right) will take precedence.

Parameters:

resourceDirectories - array of resource directories File

Returns:

current instance of AaptCommandBuilder

autoAddOverlay

public AaptCommandBuilder.AaptPackageCommandBuilder autoAddOverlay()

Automatically add resources that are only in overlays.

Returns:

current instance of AaptCommandBuilder

addRawAssetsDirectoryIfExists

public AaptCommandBuilder.AaptPackageCommandBuilder addRawAssetsDirectoryIfExists(File assetsFolder)

Additional directory in which to find raw asset files.

Parameters:

assetsFolder - Folder containing the combined raw assets to add.

Returns:

current instance of AaptCommandBuilder

addExistingPackageToBaseIncludeSet

public AaptCommandBuilder.AaptPackageCommandBuilder addExistingPackageToBaseIncludeSet(File path)

Add an existing package to base include set.

Parameters:

path - Path to existing package to add.

Returns:

current instance of AaptCommandBuilder

addConfigurations

public AaptCommandBuilder.AaptPackageCommandBuilder addConfigurations(String configurations)

Specify which configurations to include. The default is all configurations. The value of the parameter should be a comma separated list of configuration values. Locales should be specified as either a language or language-region pair.

Some examples:

• en
• port,en
• port,land,en_US

If you put the special locale, zz_ZZ on the list, it will perform pseudolocalization on the default locale, modifying all of the strings so you can look for strings that missed the internationalization process.

For example:

• port,land,zz_ZZ

Parameters:

configurations - configuration to include in form of String

Returns:

current instance of AaptCommandBuilder

addExtraArguments

public AaptCommandBuilder.AaptPackageCommandBuilder addExtraArguments(String[] extraArguments)

Adds some additional aapt arguments that are not represented as separate parameters android-maven-plugin configuration.

Parameters:

extraArguments - Array of extra arguments to pass to Aapt.

Returns:

current instance of AaptCommandBuilder

setVerbose

public AaptCommandBuilder.AaptPackageCommandBuilder setVerbose(boolean isVerbose)

Makes output verbose.

Parameters:

isVerbose - if true aapt will be verbose, otherwise - no

Returns:

current instance of AaptCommandBuilder

generateRTextFile

public AaptCommandBuilder.AaptPackageCommandBuilder generateRTextFile(File folderForR)

Generates a text file containing the resource symbols of the R class in the specified folder.

Parameters:

folderForR - folder in which text file will be generated

Returns:

current instance of AaptCommandBuilder

forceOverwriteExistingFiles

public AaptCommandBuilder.AaptPackageCommandBuilder forceOverwriteExistingFiles()

Force overwrite of existing files.

Returns:

current instance of AaptCommandBuilder

disablePngCrunching

public AaptCommandBuilder.AaptPackageCommandBuilder disablePngCrunching()

Disable PNG crunching.

Returns:

current instance of AaptCommandBuilder

setOutputApkFile

public AaptCommandBuilder.AaptPackageCommandBuilder setOutputApkFile(File outputFile)

Specify the apk file to output.

Returns:

current instance of AaptCommandBuilder

setProguardOptionsOutputFile

public AaptCommandBuilder.AaptPackageCommandBuilder setProguardOptionsOutputFile(File outputFile)

Output Proguard options to a File.

Returns:

current instance of AaptCommandBuilder

renameManifestPackage

public AaptCommandBuilder.AaptPackageCommandBuilder renameManifestPackage(String manifestPackage)

Rewrite the manifest so that its package name is the package name given here.
Relative class names (for example .Foo) will be changed to absolute names with the old package so that the code does not need to change.

Parameters:

manifestPackage - new manifest package to apply

Returns:

current instance of AaptCommandBuilder.AaptPackageCommandBuilder

renameInstrumentationTargetPackage

public AaptCommandBuilder.AaptPackageCommandBuilder renameInstrumentationTargetPackage(String instrumentationPackage)

Rewrite the manifest so that all of its instrumentation components target the given package.
Useful when used in conjunction with --rename-manifest-package to fix tests against a package that has been renamed.

Parameters:

instrumentationPackage - new instrumentation target package to apply

Returns:

current instance of AaptCommandBuilder.AaptPackageCommandBuilder

setDebugMode

public AaptCommandBuilder.AaptPackageCommandBuilder setDebugMode(boolean isDebugMode)

Inserts android:debuggable="true" into the application node of the manifest, making the application debuggable even on production devices.

Returns:

current instance of AaptCommandBuilder.AaptPackageCommandBuilder