AbstractAndroidMojo (Android Maven Plugin - android-maven-plugin 4.6.0 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - com.simpligility.maven.plugins.android.AbstractAndroidMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AarMojo, AbstractEmulatorMojo, AbstractInstrumentationMojo, AbstractPublisherMojo, ApklibMojo, ApkMojo, ConnectMojo, D8Mojo, DeployApkMojo, DeployDependenciesMojo, DeployMojo, DevicesMojo, DexMojo, DisconnectMojo, EmmaMojo, GenerateSourcesMojo, LintMojo, ManifestMergerMojo, ManifestUpdateMojo, MonkeyMojo, MonkeyRunnerMojo, ProguardMojo, PullMojo, PushMojo, RedeployApkMojo, RedeployMojo, RunMojo, UIAutomatorMojo, UndeployApkMojo, UndeployMojo, UnpackMojo, ZipalignMojo
```
public abstract class AbstractAndroidMojo
extends org.apache.maven.plugin.AbstractMojo
```
Contains common fields and methods for android mojos.

Author:

hugo.josefson@jayway.com, Manfred Moser - manfred@simpligility.com, William Ferguson - william.ferguson@xandar.com.au, Malachi de AElfweald malachid@gmail.com, Roy Clarkson - rclarkson@gopivotal.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`aaptExtraArgs` A list of extra arguments that must be passed to aapt.
`protected boolean`	`aaptVerbose` Activate verbose output for the aapt execution in Maven debug mode.
`protected int`	`adbConnectionTimeout` The timeout value for an adb connection in milliseconds.
`protected File`	`androidManifestFile` The `AndroidManifest.xml` file.
`protected File`	`assetsDirectory` The android assets directory.
`protected boolean`	`attachJar` Whether to attach the normal .jar file to the build, so it can be depended on by for example integration-tests which may then access `R.java` from this project.
`protected boolean`	`attachSources` Whether to attach sources to the build, which can be depended on by other `apk` projects, for including them in their builds.
`protected File`	`combinedAssets` The combined assets directory.
`protected String`	`configurations` A selection of configurations to be included in the APK as a comma separated list.
`protected String`	`customPackage` Generates R.java into a different package.
`protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder`	`dependencyGraphBuilder` Dependency graph builder component.
`protected File`	`destinationManifestFile` Path to which to save the result of updating/merging/processing the source `AndroidManifest.xml` file (`androidManifestFile`).
`protected String`	`device` Specifies which the serial number of the device to connect to.
`protected String[]`	`devices` Specifies a list of serial numbers of each device you want to connect to.
`protected int`	`deviceThreads` Specifies the number of threads to use for deploying and testing on attached devices.
`static String`	`ENV_ANDROID_HOME` The `ANDROID_HOME` environment variable name.
`static String`	`ENV_ANDROID_NDK_HOME` The `ANDROID_NDK_HOME` environment variable name.
`protected org.apache.maven.plugin.MojoExecution`	`execution`
`protected File`	`extractedDependenciesDirectory`
`protected File`	`extractedDependenciesJavaResources`
`protected File`	`extractedDependenciesJavaSources`
`protected String`	`finalName` The final name of the artifact.
`protected File`	`genDirectory` Override default generated folder containing R.java
`protected boolean`	`generateApk` Decides whether the Apk should be generated or not.
`protected String[]`	`ips` External IP addresses.
`protected File`	`nativeLibrariesDirectory` Root folder containing native libraries to include in the application package.
`protected File`	`ndkOutputDirectory` Folder in which the ndk libraries are collected ready for packaging.
`protected File`	`proguardFile` Automatically create a ProGuard configuration file that will guard Activity classes and the like that are defined in the AndroidManifest.xml.
`protected org.apache.maven.project.MavenProject`	`project` The maven project.
`protected org.apache.maven.project.MavenProjectHelper`	`projectHelper` Maven ProjectHelper.
`protected File`	`projectOutputDirectory` The output directory.
`protected boolean`	`release` Whether to create a release build (default is false / debug build).
`protected String`	`renameManifestPackage` A possibly new package name for the application.
`protected File`	`resourceDirectory` The Android resources (src/main/res) directory.
`protected File[]`	`resourceOverlayDirectories` The android resources overlay directories.
`protected File`	`resourceOverlayDirectory` The android resources overlay directory.
`protected List<org.apache.maven.model.Resource>`	`resources` The project resources.
`protected org.apache.maven.execution.MavenSession`	`session` The maven session.
`protected File`	`sourceDirectory` The java sources directory.
`protected String`	`sourceEncoding` The project source encoding.
`static List<String>`	`SUPPORTED_PACKAGING_TYPES`
`protected File`	`targetDirectory` The project build directory.
`protected boolean`	`undeployBeforeDeploy` Whether to undeploy an apk from the device before deploying it.

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor and Description

AbstractAndroidMojo()

Constructors
Constructor and Description
`AbstractAndroidMojo()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`copyFolder(File sourceFolder, File targetFolder)` Copies the files contained within the source folder to the target folder.
`protected void`	`deployApk(File apkFile)` Deploys an apk file to a connected emulator or usb device.
`protected void`	`deployBuiltApk()` Deploy the apk built with the current projects to all attached devices and emulators.
`protected void`	`deployDependencies()`
`protected void`	`doWithDevices(DeviceCallback deviceCallback)` Performs the callback action on the devices determined by `shouldDoWithThisDevice(com.android.ddmlib.IDevice)`
`protected String`	`extractInstrumentationRunnerFromAndroidManifest(File manifestFile)` Attempts to find the instrumentation test runner from inside the AndroidManifest.xml file.
`protected String`	`extractPackageNameFromAndroidArtifact(org.apache.maven.artifact.Artifact artifact)` Provides package name for android artifact.
`protected String`	`extractPackageNameFromAndroidManifest(File manifestFile)`
`protected String`	`extractPackageNameFromAndroidManifestXmlTree(String aaptDumpXmlTree)` Extracts the package name from an XmlTree dump of AndroidManifest.xml by the `aapt` tool.
`protected String`	`extractPackageNameFromApk(File apkFile)` Extracts the package name from an apk file.
`protected String`	`getAndroidManifestPackageName()`
`protected AndroidNdk`	`getAndroidNdk()` Returns the Android NDK to use.
`protected AndroidSdk`	`getAndroidSdk()` Returns the Android SDK to use.
`protected ArtifactResolverHelper`	`getArtifactResolverHelper()`
`protected DependencyResolver`	`getDependencyResolver()`
`protected Set<org.apache.maven.artifact.Artifact>`	`getDirectDependencyArtifacts()`
`protected Jack`	`getJack()`
`static File`	`getLibraryUnpackDirectory(File unpackedApkLibsDirectory, org.apache.maven.artifact.Artifact artifact)`
`protected NativeHelper`	`getNativeHelper()`
`protected Set<org.apache.maven.artifact.Artifact>`	`getRelevantCompileArtifacts()`
`File[]`	`getResourceOverlayDirectories()`
`protected Set<org.apache.maven.artifact.Artifact>`	`getTransitiveDependencyArtifacts(List<String> filteredScopes, String... types)` Provides transitive dependency artifacts only defined types based on `types` argument or all types if `types` argument is empty
`protected Set<org.apache.maven.artifact.Artifact>`	`getTransitiveDependencyArtifacts(String... types)` Provides transitive dependency artifacts having types defined by `types` argument or all types if `types` argument is empty
`protected File`	`getUnpackedAarClassesJar(org.apache.maven.artifact.Artifact artifact)`
`protected File`	`getUnpackedApkLibSourceFolder(org.apache.maven.artifact.Artifact artifact)`
`protected File`	`getUnpackedLibAssetsFolder(org.apache.maven.artifact.Artifact artifact)`
`File`	`getUnpackedLibFolder(org.apache.maven.artifact.Artifact artifact)`
`protected UnpackedLibHelper`	`getUnpackedLibHelper()`
`File`	`getUnpackedLibNativesFolder(org.apache.maven.artifact.Artifact artifact)`
`protected File`	`getUnpackedLibResourceFolder(org.apache.maven.artifact.Artifact artifact)`
`protected File`	`getUnpackedLibsDirectory()`
`protected com.android.ddmlib.AndroidDebugBridge`	`initAndroidDebugBridge()` Initialize the Android Debug Bridge and wait for it to start.
`protected boolean`	`isAPKBuild()`
`protected boolean`	`isInstrumentationTest()`
`protected File`	`resolveArtifactToFile(org.apache.maven.artifact.Artifact artifact)` Attempts to resolve an `Artifact` to a `File`.
`protected boolean`	`undeployApk(File apkFile)` Undeploys an apk from a connected emulator or usb device.
`protected boolean`	`undeployApk(String packageName)` Undeploys an apk, specified by package name, from a connected emulator or usb device.
`protected void`	`waitForInitialDeviceList(com.android.ddmlib.AndroidDebugBridge androidDebugBridge)` Wait for the Android Debug Bridge to return an initial device list.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo
execute

- Field Detail
  - SUPPORTED_PACKAGING_TYPES
```
public static final List<String> SUPPORTED_PACKAGING_TYPES
```
  - ENV_ANDROID_NDK_HOME
```
public static final String ENV_ANDROID_NDK_HOME
```
    The ANDROID_NDK_HOME environment variable name.
    
    See Also:
    
    Constant Field Values
  - project
```
@Component
protected org.apache.maven.project.MavenProject project
```
    The maven project.
  - session
```
@Component
protected org.apache.maven.execution.MavenSession session
```
    The maven session.
  - execution
```
@Component
protected org.apache.maven.plugin.MojoExecution execution
```
  - sourceDirectory
```
@Parameter(defaultValue="${project.build.sourceDirectory}",
           readonly=true)
protected File sourceDirectory
```
    The java sources directory.
  - targetDirectory
```
@Parameter(defaultValue="${project.build.directory}",
           readonly=true)
protected File targetDirectory
```
    The project build directory. Ie target.
  - projectOutputDirectory
```
@Parameter(defaultValue="${project.build.outputDirectory}",
           readonly=true)
protected File projectOutputDirectory
```
    The output directory. Ie target/classes.
  - resources
```
@Parameter(defaultValue="${project.build.resources}",
           readonly=true)
protected List<org.apache.maven.model.Resource> resources
```
    The project resources. By default a list containing src/main/resources.
  - finalName
```
@Parameter(defaultValue="${project.build.finalName}",
           readonly=true)
protected String finalName
```
    The final name of the artifact.
  - resourceDirectory
```
@Parameter(defaultValue="${project.basedir}/src/main/res")
protected File resourceDirectory
```
    The Android resources (src/main/res) directory. Note that this is different from the Maven/Java resources directory (src/main/resources) and should not be set to be the same since different processing is carried out on these folder by different plugins and tools.
  - sourceEncoding
```
@Parameter(defaultValue="${project.build.sourceEncoding}",
           readonly=true)
protected String sourceEncoding
```
    The project source encoding. It will use the platform default encoding if the property is not set.
  - genDirectory
```
@Parameter(property="android.genDirectory",
           defaultValue="${project.build.directory}/generated-sources/r")
protected File genDirectory
```
    Override default generated folder containing R.java
  - nativeLibrariesDirectory
```
@Parameter(property="android.nativeLibrariesDirectory",
           defaultValue="${project.basedir}/src/main/libs")
protected File nativeLibrariesDirectory
```
    Root folder containing native libraries to include in the application package.
  - ndkOutputDirectory
```
@Parameter(defaultValue="${project.build.directory}/ndk-libs",
           readonly=true)
protected File ndkOutputDirectory
```
    Folder in which the ndk libraries are collected ready for packaging.
  - resourceOverlayDirectory
```
@Parameter(defaultValue="${project.basedir}/res-overlay")
protected File resourceOverlayDirectory
```
    The android resources overlay directory. This will be overridden by resourceOverlayDirectories if present.
  - resourceOverlayDirectories
```
@Parameter
protected File[] resourceOverlayDirectories
```
    The android resources overlay directories. If this is specified, the resourceOverlayDirectory parameter will be ignored.
  - assetsDirectory
```
@Parameter(defaultValue="${project.basedir}/src/main/assets")
protected File assetsDirectory
```
    The android assets directory.
  - androidManifestFile
```
@Parameter(property="android.manifestFile",
           defaultValue="${project.basedir}/src/main/AndroidManifest.xml")
protected File androidManifestFile
```
    The AndroidManifest.xml file.
  - destinationManifestFile
```
@Parameter(property="destination.manifestFile",
           defaultValue="${project.build.directory}/AndroidManifest.xml")
protected File destinationManifestFile
```
    Path to which to save the result of updating/merging/processing the source AndroidManifest.xml file (androidManifestFile).
  - renameManifestPackage
```
@Parameter(property="android.renameManifestPackage")
protected String renameManifestPackage
```
    A possibly new package name for the application. This value will be passed on to the aapt parameter --rename-manifest-package. Look to aapt for more help on this.
  - extractedDependenciesDirectory
```
@Parameter(defaultValue="${project.build.directory}/generated-sources/extracted-dependencies",
           readonly=true)
protected File extractedDependenciesDirectory
```
  - extractedDependenciesJavaSources
```
@Parameter(defaultValue="${project.build.directory}/generated-sources/extracted-dependencies/src/main/java",
           readonly=true)
protected File extractedDependenciesJavaSources
```
  - extractedDependenciesJavaResources
```
@Parameter(defaultValue="${project.build.directory}/generated-sources/extracted-dependencies/src/main/resources",
           readonly=true)
protected File extractedDependenciesJavaResources
```
  - combinedAssets
```
@Parameter(defaultValue="${project.build.directory}/generated-sources/combined-assets",
           readonly=true)
protected File combinedAssets
```
    The combined assets directory. This will contain both the assets found in "assets" as well as any assets contained in a apksources, apklib or aar dependencies.
  - device
```
@Parameter(property="android.device")
protected String device
```
    Specifies which the serial number of the device to connect to. Using the special values "usb" or "emulator" is also valid. "usb" will connect to all actual devices connected (via usb). "emulator" will connect to all emulators connected. Multiple devices will be iterated over in terms of goals to run. All device interaction goals support this so you can e.. deploy the apk to all attached emulators and devices. Goals supporting this are devices, deploy, undeploy, redeploy, pull, push and instrument.
  - devices
```
@Parameter(property="android.devices")
protected String[] devices
```
    Specifies a list of serial numbers of each device you want to connect to. Using the special values "usb" or "emulator" is also valid. "usb" will connect to all actual devices connected (via usb). "emulator" will connect to all emulators connected. Multiple devices will be iterated over in terms of goals to run. All device interaction goals support this so you can e.. deploy the apk to all attached emulators and devices. Goals supporting this are devices, deploy, undeploy, redeploy, pull, push and instrument.
```
 <devices>
     <device>usb</device>
     <device>emulator-5554</device>
 </devices>
 
```
    This parameter can also be configured from command-line with parameter -Dandroid.devices=usb,emulator.
  - deviceThreads
```
@Parameter(property="android.deviceThreads")
protected int deviceThreads
```
    Specifies the number of threads to use for deploying and testing on attached devices.
    This parameter can also be configured from command-line with parameter -Dandroid.deviceThreads=2.
  - ips
```
@Parameter(property="android.ips")
protected String[] ips
```
    External IP addresses. The connect goal of the android maven plugin will execute an adb connect on each IP address. If you have external dervice, you should call this connect goal before any other goal : mvn clean android:connect install.
    
    The Maven plugin will automatically add all these IP addresses into the the devices parameter. If you want to disconnect the IP addresses after the build, you can call the disconnect goal : mvn clean android:connect install android:disconnect
```
 <ips>
     <ip>127.0.0.1:5556</ip>
 </ips>
 
```
  - configurations
```
@Parameter(property="android.configurations")
protected String configurations
```
    A selection of configurations to be included in the APK as a comma separated list. This will limit the configurations for a certain type. For example, specifying hdpi will exclude all resource folders with the mdpi or ldpi modifiers, but won't affect language or orientation modifiers. For more information about this option, look in the aapt command line help.
  - aaptExtraArgs
```
@Parameter(property="android.aaptExtraArgs")
protected String[] aaptExtraArgs
```
    A list of extra arguments that must be passed to aapt.
  - aaptVerbose
```
@Parameter(property="android.aaptVerbose")
protected boolean aaptVerbose
```
    Activate verbose output for the aapt execution in Maven debug mode. Defaults to "false"
  - proguardFile
```
@Parameter(property="android.proguardFile")
protected File proguardFile
```
    Automatically create a ProGuard configuration file that will guard Activity classes and the like that are defined in the AndroidManifest.xml. This files is then automatically used in the proguard mojo execution, if enabled.
  - generateApk
```
@Parameter(property="android.generateApk",
           defaultValue="true")
protected boolean generateApk
```
    Decides whether the Apk should be generated or not. If set to false, dx and apkBuilder will not run. This is probably most useful for a project used to generate apk sources to be inherited into another application project.
  - customPackage
```
@Parameter(property="android.customPackage")
protected String customPackage
```
    Generates R.java into a different package.
  - projectHelper
```
@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper
```
    Maven ProjectHelper.
  - ENV_ANDROID_HOME
```
public static final String ENV_ANDROID_HOME
```
    The ANDROID_HOME environment variable name.
    
    See Also:
    
    Constant Field Values
  - undeployBeforeDeploy
```
@Parameter(property="android.undeployBeforeDeploy",
           defaultValue="false")
protected boolean undeployBeforeDeploy
```
    Whether to undeploy an apk from the device before deploying it.
    
    Only has effect when running mvn android:deploy in an Android application project manually, or when running mvn integration-test (or mvn install) in a project with instrumentation tests.
    
    It is useful to keep this set to true at all times, because if an apk with the same package was previously signed with a different keystore, and deployed to the device, deployment will fail because your keystore is different.
  - attachJar
```
@Parameter(property="android.attachJar",
           defaultValue="true")
protected boolean attachJar
```
    Whether to attach the normal .jar file to the build, so it can be depended on by for example integration-tests which may then access R.java from this project.
    
    Only disable it if you know you won't need it for any integration-tests. Otherwise, leave it enabled.
  - attachSources
```
@Parameter(property="android.attachSources",
           defaultValue="false")
protected boolean attachSources
```
    Whether to attach sources to the build, which can be depended on by other apk projects, for including them in their builds.
    
    Enabling this setting is only required if this project's source code and/or res(ources) will be included in other projects, using the Maven <dependency> tag.
  - release
```
@Parameter(property="android.release",
           defaultValue="false")
protected boolean release
```
    Whether to create a release build (default is false / debug build). This affect BuildConfig generation and apk generation at this stage, but should probably affect other aspects of the build.
  - adbConnectionTimeout
```
@Parameter(property="android.adb.connectionTimeout",
           defaultValue="5000")
protected int adbConnectionTimeout
```
    The timeout value for an adb connection in milliseconds.
  - dependencyGraphBuilder
```
@Component(hint="default")
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder dependencyGraphBuilder
```
    Dependency graph builder component.
- Constructor Detail
  - AbstractAndroidMojo
```
public AbstractAndroidMojo()
```
- Method Detail
  - getDependencyResolver
```
protected final DependencyResolver getDependencyResolver()
```
  - getRelevantCompileArtifacts
```
protected Set<org.apache.maven.artifact.Artifact> getRelevantCompileArtifacts()
```
    Returns:
    
    a Set of dependencies which may be extracted and otherwise included in other artifacts. Never null. This excludes artifacts of the EXCLUDED_DEPENDENCY_SCOPES scopes.
  - getDirectDependencyArtifacts
```
protected Set<org.apache.maven.artifact.Artifact> getDirectDependencyArtifacts()
```
    Returns:
    
    a Set of direct project dependencies. Never null. This excludes artifacts of the EXCLUDED_DEPENDENCY_SCOPES scopes.
  - getTransitiveDependencyArtifacts
```
protected Set<org.apache.maven.artifact.Artifact> getTransitiveDependencyArtifacts(String... types)
```
    Provides transitive dependency artifacts having types defined by types argument or all types if types argument is empty
    
    Parameters:
    
    types - artifact types to be selected
    
    Returns:
    
    a List of all project dependencies. Never null. This excludes artifacts of the ArtifactResolverHelper.EXCLUDE_NON_PACKAGED_SCOPES scopes. This should maintain dependency order to comply with library project resource precedence.
  - getTransitiveDependencyArtifacts
```
protected Set<org.apache.maven.artifact.Artifact> getTransitiveDependencyArtifacts(List<String> filteredScopes,
                                                                                   String... types)
```
    Provides transitive dependency artifacts only defined types based on types argument or all types if types argument is empty
    
    Parameters:
    
    filteredScopes - List of scopes to be removed (ie filtered out).
    
    types - Zero or more artifact types to be selected.
    
    Returns:
    
    a List of all project dependencies. Never null. This should maintain dependency order to comply with library project resource precedence.
  - resolveArtifactToFile
```
protected File resolveArtifactToFile(org.apache.maven.artifact.Artifact artifact)
                              throws org.apache.maven.plugin.MojoExecutionException
```
    Attempts to resolve an Artifact to a File.
    
    Parameters:
    
    artifact - to resolve
    
    Returns:
    
    a File to the resolved artifact, never null.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - if the artifact could not be resolved.
  - initAndroidDebugBridge
```
protected com.android.ddmlib.AndroidDebugBridge initAndroidDebugBridge()
                                                                throws org.apache.maven.plugin.MojoExecutionException
```
    Initialize the Android Debug Bridge and wait for it to start. Does not reinitialize it if it has already been initialized (that would through and IllegalStateException...). Synchronized sine the init call in the library is also synchronized .. just in case.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - waitForInitialDeviceList
```
protected void waitForInitialDeviceList(com.android.ddmlib.AndroidDebugBridge androidDebugBridge)
                                 throws org.apache.maven.plugin.MojoExecutionException
```
    Wait for the Android Debug Bridge to return an initial device list.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - deployApk
```
protected void deployApk(File apkFile)
                  throws org.apache.maven.plugin.MojoExecutionException,
                         org.apache.maven.plugin.MojoFailureException
```
    Deploys an apk file to a connected emulator or usb device.
    
    Parameters:
    
    apkFile - the file to deploy
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - If there is a problem deploying the apk file.
    
    org.apache.maven.plugin.MojoFailureException
  - deployDependencies
```
protected void deployDependencies()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - deployBuiltApk
```
protected void deployBuiltApk()
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException
```
    Deploy the apk built with the current projects to all attached devices and emulators. Skips other projects in a multi-module build without terminating.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - doWithDevices
```
protected void doWithDevices(DeviceCallback deviceCallback)
                      throws org.apache.maven.plugin.MojoExecutionException,
                             org.apache.maven.plugin.MojoFailureException
```
    Performs the callback action on the devices determined by shouldDoWithThisDevice(com.android.ddmlib.IDevice)
    
    Parameters:
    
    deviceCallback - the action to perform on each device
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - in case there is a problem
    
    org.apache.maven.plugin.MojoFailureException - in case there is a problem
  - undeployApk
```
protected boolean undeployApk(File apkFile)
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException
```
    Undeploys an apk from a connected emulator or usb device. Also deletes the application's data and cache directories on the device.
    
    Parameters:
    
    apkFile - the file to undeploy
    
    Returns:
    
    true if successfully undeployed, false otherwise.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - undeployApk
```
protected boolean undeployApk(String packageName)
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException
```
    Undeploys an apk, specified by package name, from a connected emulator or usb device. Also deletes the application's data and cache directories on the device.
    
    Parameters:
    
    packageName - the package name to undeploy.
    
    Returns:
    
    true if successfully undeployed, false otherwise.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - extractPackageNameFromApk
```
protected String extractPackageNameFromApk(File apkFile)
                                    throws org.apache.maven.plugin.MojoExecutionException
```
    Extracts the package name from an apk file.
    
    Parameters:
    
    apkFile - apk file to extract package name from.
    
    Returns:
    
    the package name from inside the apk file.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - extractPackageNameFromAndroidManifestXmlTree
```
protected String extractPackageNameFromAndroidManifestXmlTree(String aaptDumpXmlTree)
```
    Extracts the package name from an XmlTree dump of AndroidManifest.xml by the aapt tool.
    
    Parameters:
    
    aaptDumpXmlTree - output from aapt dump xmltree <apkFile> AndroidManifest.xml
    Returns: the package name from inside the apkFile.
  extractPackageNameFromAndroidArtifact protected String extractPackageNameFromAndroidArtifact(org.apache.maven.artifact.Artifact artifact) throws org.apache.maven.plugin.MojoExecutionException Provides package name for android artifact. Parameters: artifact - android artifact which package have to be extracted Returns: package name Throws: org.apache.maven.plugin.MojoExecutionException - if there is no AndroidManifest.xml for provided artifact or appears error while parsing in extractPackageNameFromAndroidManifest(File) See Also: extractPackageNameFromAndroidManifest(File) extractPackageNameFromAndroidManifest protected String extractPackageNameFromAndroidManifest(File manifestFile) getAndroidManifestPackageName protected final String getAndroidManifestPackageName() Returns: the package name from this project's Android Manifest. extractInstrumentationRunnerFromAndroidManifest protected String extractInstrumentationRunnerFromAndroidManifest(File manifestFile) throws org.apache.maven.plugin.MojoExecutionException Attempts to find the instrumentation test runner from inside the AndroidManifest.xml file. Parameters: manifestFile - the AndroidManifest.xml file to inspect. Returns: the instrumentation test runner declared in AndroidManifest.xml, or null if it is not declared. Throws: org.apache.maven.plugin.MojoExecutionException isInstrumentationTest protected final boolean isInstrumentationTest() throws org.apache.maven.plugin.MojoExecutionException Throws: org.apache.maven.plugin.MojoExecutionException getAndroidSdk protected AndroidSdk getAndroidSdk() throws org.apache.maven.plugin.MojoExecutionException Returns the Android SDK to use. Current implementation looks for System property android.sdk.path, then <sdk><path> configuration in pom, then environment variable ANDROID_HOME. This is where we collect all logic for how to lookup where it is, and which one to choose. The lookup is based on available parameters. This method should be the only one you should need to look at to understand how the Android SDK is chosen, and from where on disk. Returns: the Android SDK to use. Throws: org.apache.maven.plugin.MojoExecutionException - if no Android SDK path configuration is available at all. getJack protected Jack getJack() getUnpackedLibsDirectory protected final File getUnpackedLibsDirectory() getUnpackedLibFolder public final File getUnpackedLibFolder(org.apache.maven.artifact.Artifact artifact) getUnpackedAarClassesJar protected final File getUnpackedAarClassesJar(org.apache.maven.artifact.Artifact artifact) getUnpackedApkLibSourceFolder protected final File getUnpackedApkLibSourceFolder(org.apache.maven.artifact.Artifact artifact) getUnpackedLibResourceFolder protected final File getUnpackedLibResourceFolder(org.apache.maven.artifact.Artifact artifact) getUnpackedLibAssetsFolder protected final File getUnpackedLibAssetsFolder(org.apache.maven.artifact.Artifact artifact) getUnpackedLibNativesFolder public final File getUnpackedLibNativesFolder(org.apache.maven.artifact.Artifact artifact) Parameters: artifact - Android dependency that is being referenced. Returns: Folder where the unpacked native libraries are located. getLibraryUnpackDirectory public static File getLibraryUnpackDirectory(File unpackedApkLibsDirectory, org.apache.maven.artifact.Artifact artifact) getAndroidNdk protected AndroidNdk getAndroidNdk() throws org.apache.maven.plugin.MojoExecutionException Returns the Android NDK to use. Current implementation looks for <ndk><path> configuration in pom, then System property android.ndk.path, then environment variable ANDROID_NDK_HOME. This is where we collect all logic for how to lookup where it is, and which one to choose. The lookup is based on available parameters. This method should be the only one you should need to look at to understand how the Android NDK is chosen, and from where on disk. Returns: the Android NDK to use. Throws: org.apache.maven.plugin.MojoExecutionException - if no Android NDK path configuration is available at all. getResourceOverlayDirectories public File[] getResourceOverlayDirectories() Returns: the resource directories if defined or the resource directory. isAPKBuild protected final boolean isAPKBuild() Returns: True if this project constructs an APK as opposed to an AAR or APKLIB. copyFolder protected final void copyFolder(File sourceFolder, File targetFolder) throws org.apache.maven.plugin.MojoExecutionException Copies the files contained within the source folder to the target folder. The the target folder doesn't exist it will be created. Parameters: sourceFolder - Folder from which to copy the resources. targetFolder - Folder to which to copy the files. Throws: org.apache.maven.plugin.MojoExecutionException - if the files cannot be copied. getUnpackedLibHelper protected final UnpackedLibHelper getUnpackedLibHelper() getArtifactResolverHelper protected final ArtifactResolverHelper getArtifactResolverHelper() getNativeHelper protected final NativeHelper getNativeHelper()

Class AbstractAndroidMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.maven.plugin.Mojo

Field Detail

SUPPORTED_PACKAGING_TYPES

ENV_ANDROID_NDK_HOME

project

session

execution

sourceDirectory

targetDirectory

projectOutputDirectory

resources

finalName

resourceDirectory

sourceEncoding

genDirectory

nativeLibrariesDirectory

ndkOutputDirectory

resourceOverlayDirectory

resourceOverlayDirectories

assetsDirectory

androidManifestFile

destinationManifestFile

renameManifestPackage

extractedDependenciesDirectory

extractedDependenciesJavaSources

extractedDependenciesJavaResources

combinedAssets

device

devices

deviceThreads

ips

configurations

aaptExtraArgs

aaptVerbose

proguardFile

generateApk

customPackage

projectHelper

ENV_ANDROID_HOME

undeployBeforeDeploy

attachJar

attachSources

release

adbConnectionTimeout

dependencyGraphBuilder

Constructor Detail

AbstractAndroidMojo

Method Detail

getDependencyResolver

getRelevantCompileArtifacts

getDirectDependencyArtifacts

getTransitiveDependencyArtifacts

getTransitiveDependencyArtifacts

resolveArtifactToFile

initAndroidDebugBridge

waitForInitialDeviceList

deployApk

deployDependencies

deployBuiltApk

doWithDevices

undeployApk

undeployApk

extractPackageNameFromApk

extractPackageNameFromAndroidManifestXmlTree

extractPackageNameFromAndroidArtifact

extractPackageNameFromAndroidManifest

getAndroidManifestPackageName

extractInstrumentationRunnerFromAndroidManifest

isInstrumentationTest

getAndroidSdk

getJack

getUnpackedLibsDirectory

getUnpackedLibFolder