Fork me on GitHub

android:lint

Full name:

com.simpligility.maven.plugins:android-maven-plugin:4.5.0:lint

Description:

LintMojo can run the lint command against the project. Implements parsing parameters from pom or command line arguments and sets useful defaults as well. Warning, if you use android.lint.enableClasspath and/or android.lint.enableLibraries the behavior of this goal will vary depending on the phase where this goal is executed. See android.lint.classpath/lintClassPath and android.lint.libraries/lintLibraries for more details.

Attributes:

Optional Parameters

Name Type Since Description
aaptExtraArgs String[] - A list of extra arguments that must be passed to aapt.
User property is: android.aaptExtraArgs.
aaptVerbose boolean - Activate verbose output for the aapt execution in Maven debug mode. Defaults to "false"
User property is: android.aaptVerbose.
adbConnectionTimeout int - The timeout value for an adb connection in milliseconds.
Default value is: 5000.
User property is: android.adb.connectionTimeout.
androidManifestFile File - The AndroidManifest.xml file.
Default value is: ${project.basedir}/src/main/AndroidManifest.xml.
User property is: android.manifestFile.
assetsDirectory File - The android assets directory.
Default value is: ${project.basedir}/src/main/assets.
attachJar boolean -

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.


Default value is: true.
User property is: android.attachJar.
attachSources boolean -

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.


Default value is: false.
User property is: android.attachSources.
configurations String - 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.
User property is: android.configurations.
customPackage String - Generates R.java into a different package.
User property is: android.customPackage.
destinationManifestFile File - Path to which to save the result of updating/merging/processing the source AndroidManifest.xml file (androidManifestFile).
Default value is: ${project.build.directory}/AndroidManifest.xml.
User property is: destination.manifestFile.
device String - 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.
User property is: android.device.
deviceThreads int -

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.


User property is: android.deviceThreads.
devices String[] -

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.


User property is: android.devices.
disableConflictingDependenciesWarning File - Whether the plugin should show a warning if conflicting dependencies with the Android provided ones exist.
Default value is: false.
genDirectory File - Override default generated folder containing R.java
Default value is: ${project.build.directory}/generated-sources/r.
User property is: android.genDirectory.
generateApk boolean - 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.
Default value is: true.
User property is: android.generateApk.
includeLibsJarsFromAar boolean -

Include jars stored in the libs folder of an aar as dependencies. Do not delete or change name as it is used in the LifeCycleParticipant.


Default value is: true.
includeLibsJarsFromApklib boolean -

Include jars stored in the libs folder of an apklib as dependencies. Do not delete or change name as it is used in the LifeCycleParticipant.


Default value is: false.
ips String[] -

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>

User property is: android.ips.
jack Jack - configure the Jack compiler
legacy Boolean - (no description)
User property is: android.lint.legacy.
lint Lint - The configuration for the lint goal. As soon as a lint goal is invoked the command will be executed unless the skip parameter is set. A minimal configuration that will run lint and produce a XML report in ${project.build.directory}/lint/lint-results.xml is
<lint>
    <skip>false</skip>
</lint>
Full configuration can use these parameters.
<lint>
    <failOnError>true|false</failOnError>
    <skip>true|false</skip>
    <ignoreWarnings>true|false</ignoreWarnings>
    <warnAll>true|false</warnAll>
    <warningsAsErrors>true|false</warningsAsErrors>
    <config></config>
    <fullPath>true|false</fullPath>
    <showAll>true|false</showAll>
    <disableSourceLines>true|false</disableSourceLines>
    <url>none|a=b</url>
    <enableHtml>true|false</enableHtml>
    <htmlOutputPath>${project.build.directory}/lint-results/lint-results-html/</htmlOutputPath>
    <enableSimpleHtml>true|false</enableSimpleHtml>
    <simpleHtmlOutputPath>${project.build.directory}/lint-results/lint-results-simple-html
    </simpleHtmlOutputPath>
    <enableXml>true|false</enableXml>
    <xmlOutputPath>${project.build.directory}/lint-results/lint-results.xml</xmlOutputPath>
    <enableSources>true|false</enableSources>
    <sources>${project.build.sourceDirecory}}</sources>
    <enableClasspath>true|false</enableClasspath>
    <classpath>${project.build.outputDirectory}</classpath>
    <enableLibraries>true|false</enableLibraries>
    <libraries></libraries>
</lint>
Alternatively to the plugin configuration values can also be configured as properties on the command line as android.lint.* or in pom or settings file as properties like lint*.
lintClasspath String - Add the given folder (or jar file, or path) as a class directory for the project. Only valid when running lint on a single project. Defaults to ${project.build.outputDirectory}. Consequently, the lint output depends on the phase during which this goal is executed, whether project has been compiled or not.
User property is: android.lint.classpath.
lintConfig String - Use the given configuration file to determine whether issues are enabled or disabled. Defaults is "null" so no config file will be used. To use the commonly used lint.xml in the project root set the parameter to "${project.basedir}/lint.xml".
User property is: android.lint.config.
lintDisableSourceLines Boolean - Do not include the source file lines with errors in the output. By default, the error output includes snippets of source code on the line containing the error, but this flag turns it off. Defaults to "false".
User property is: android.lint.disableSourceLines.
lintEnableClasspath Boolean - Enable including classpath into lint analysis. Defaults to "false".
User property is: android.lint.enableSources.
lintEnableHtml Boolean - Enable the creation of a HTML report. Defaults to "false".
User property is: android.lint.enableHtml.
lintEnableLibraries Boolean - Enable including libraries into lint analysis. Defaults to "false".
User property is: android.lint.enableSources.
lintEnableSimpleHtml Boolean - Enable the creation of a simple HTML report. Defaults to "false".
User property is: android.lint.enableSimpleHtml.
lintEnableSource Boolean - Enable including sources into lint analysis. Defaults to "true".
User property is: android.lint.enableSources.
lintEnableXml Boolean - Enable the creation of a XML report. Defaults to "true".
User property is: android.lint.enableXml.
lintFailOnError Boolean - Fail build on lint errors. Defaults to "false".
User property is: android.lint.failOnError.
lintFullPath Boolean - Use full paths in the error output. Defaults to "false".
User property is: android.lint.fullPath.
lintHtmlOutputPath String - Path for the HTML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-html/.
User property is: android.lint.htmlOutputPath.
lintIgnoreWarnings Boolean - Only check for errors and ignore warnings. Defaults to "false".
User property is: android.lint.ignoreWarning.
lintLibraries String - Add the given folder (or jar file, or path) as a class library for the project. Only valid when running lint on a single project. Defaults to all non provided resolved artifacts. Consequently, the lint output depends on the phase during which this goal is executed, whether project's dependencies have been resolved or not.
User property is: android.lint.libraries.
lintShowAll Boolean - Do not truncate long messages, lists of alternate locations, etc. Defaults to "true".
User property is: android.lint.showAll.
lintSimpleHtmlOutputPath String - Create a simple HTML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-simple-html/.
User property is: android.lint.simpleHtmlOutputPath.
lintSkip Boolean - Skip the lint goal execution. Defaults to "true".
User property is: android.lint.skip.
lintSources String - Add the given folder (or path) as a source directory for the project. Only valid when running lint on a single project. Defaults to ${project.build.sourceDirectory}.
User property is: android.lint.sources.
lintUrl String - Add links to HTML report, replacing local path prefixes with url prefix. The mapping can be a comma-separated list of path prefixes to corresponding URL prefixes, such as C:\temp\Proj1=http://buildserver/sources/temp/Proj1. To turn off linking to files, use --url none. Defaults to "none".
User property is: android.lint.url.
lintWarnAll Boolean - Check all warnings, including those off by default. Defaults to "false".
User property is: android.lint.warnAll.
lintWarningsAsErrors Boolean - Report all warnings as errors. Defaults to "false".
User property is: android.lint.warningsAsErrors.
lintXmlOutputPath String - Create an XML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-results.xml.
User property is: android.lint.xmlOutputPath.
nativeLibrariesDirectory File -

Root folder containing native libraries to include in the application package.


Default value is: ${project.basedir}/src/main/libs.
User property is: android.nativeLibrariesDirectory.
ndk Ndk -

The Android NDK to use.

Looks like this:

<ndk>
    <path>/opt/android-ndk-r4</path>
</ndk>

The <path> parameter is optional. The default is the setting of the ANDROID_NDK_HOME environment variable. The parameter can be used to override this setting with a different environment variable like this:

<ndk>
    <path>${env.ANDROID_NDK_HOME}</path>
</ndk>

or just with a hardcoded absolute path. The parameters can also be configured from command-line with parameter -Dandroid.ndk.path.


proguardFile File - 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.
User property is: android.proguardFile.
quiet Boolean - (no description)
User property is: android.lint.quiet.
release boolean - 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.
Default value is: false.
User property is: android.release.
renameManifestPackage String -

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.


User property is: android.renameManifestPackage.
resourceDirectory File - 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.
Default value is: ${project.basedir}/src/main/res.
resourceOverlayDirectories File[] - The android resources overlay directories. If this is specified, the resourceOverlayDirectory parameter will be ignored.
resourceOverlayDirectory File - The android resources overlay directory. This will be overridden by resourceOverlayDirectories if present.
Default value is: ${project.basedir}/res-overlay.
sdk Sdk -

The Android SDK to use.

Looks like this:

<sdk>
    <path>/opt/android-sdk-linux</path>
    <platform>2.1</platform>
</sdk>

The <platform> parameter is optional, and corresponds to the platforms/android-* directories in the Android SDK directory. Default is the latest available version, so you only need to set it if you for example want to use platform 1.5 but also have e.g. 2.2 installed. Has no effect when used on an Android SDK 1.1. The parameter can also be coded as the API level. Therefore valid values are 1.1, 1.5, 1.6, 2.0, 2.01, 2.1, 2.2 and so as well as 3, 4, 5, 6, 7, 8... 19. If a platform/api level is not installed on the machine an error message will be produced.

The <path> parameter is optional. The default is the setting of the ANDROID_HOME environment variable. The parameter can be used to override this setting with a different environment variable like this:

<sdk>
    <path>${env.ANDROID_SDK}</path>
</sdk>

or just with a hard-coded absolute path. The parameters can also be configured from command-line with parameters -Dandroid.sdk.path and -Dandroid.sdk.platform.


undeployBeforeDeploy boolean -

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.


Default value is: false.
User property is: android.undeployBeforeDeploy.
unpackedLibsFolder File - Folder in which AAR library dependencies will be unpacked.
Default value is: ${project.build.directory}/unpacked-libs.
User property is: unpackedLibsFolder.

Parameter Details

aaptExtraArgs:

A list of extra arguments that must be passed to aapt.
  • Type: java.lang.String[]
  • Required: No
  • User Property: android.aaptExtraArgs

aaptVerbose:

Activate verbose output for the aapt execution in Maven debug mode. Defaults to "false"
  • Type: boolean
  • Required: No
  • User Property: android.aaptVerbose

adbConnectionTimeout:

The timeout value for an adb connection in milliseconds.
  • Type: int
  • Required: No
  • User Property: android.adb.connectionTimeout
  • Default: 5000

androidManifestFile:

The AndroidManifest.xml file.
  • Type: java.io.File
  • Required: No
  • User Property: android.manifestFile
  • Default: ${project.basedir}/src/main/AndroidManifest.xml

assetsDirectory:

The android assets directory.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/src/main/assets

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.

  • Type: boolean
  • Required: No
  • User Property: android.attachJar
  • Default: true

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.

  • Type: boolean
  • Required: No
  • User Property: android.attachSources
  • Default: false

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.
  • Type: java.lang.String
  • Required: No
  • User Property: android.configurations

customPackage:

Generates R.java into a different package.
  • Type: java.lang.String
  • Required: No
  • User Property: android.customPackage

destinationManifestFile:

Path to which to save the result of updating/merging/processing the source AndroidManifest.xml file (androidManifestFile).
  • Type: java.io.File
  • Required: No
  • User Property: destination.manifestFile
  • Default: ${project.build.directory}/AndroidManifest.xml

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.
  • Type: java.lang.String
  • Required: No
  • User Property: android.device

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.

  • Type: int
  • Required: No
  • User Property: android.deviceThreads

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.

  • Type: java.lang.String[]
  • Required: No
  • User Property: android.devices

disableConflictingDependenciesWarning:

Whether the plugin should show a warning if conflicting dependencies with the Android provided ones exist.
  • Type: java.io.File
  • Required: No
  • Default: false

genDirectory:

Override default generated folder containing R.java
  • Type: java.io.File
  • Required: No
  • User Property: android.genDirectory
  • Default: ${project.build.directory}/generated-sources/r

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.
  • Type: boolean
  • Required: No
  • User Property: android.generateApk
  • Default: true

includeLibsJarsFromAar:

Include jars stored in the libs folder of an aar as dependencies. Do not delete or change name as it is used in the LifeCycleParticipant.

  • Type: boolean
  • Required: No
  • Default: true

includeLibsJarsFromApklib:

Include jars stored in the libs folder of an apklib as dependencies. Do not delete or change name as it is used in the LifeCycleParticipant.

  • Type: boolean
  • Required: No
  • Default: false

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>
  • Type: java.lang.String[]
  • Required: No
  • User Property: android.ips

jack:

configure the Jack compiler
  • Type: com.simpligility.maven.plugins.android.configuration.Jack
  • Required: No

legacy:

(no description)
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.legacy

lint:

The configuration for the lint goal. As soon as a lint goal is invoked the command will be executed unless the skip parameter is set. A minimal configuration that will run lint and produce a XML report in ${project.build.directory}/lint/lint-results.xml is
<lint>
    <skip>false</skip>
</lint>
Full configuration can use these parameters.
<lint>
    <failOnError>true|false</failOnError>
    <skip>true|false</skip>
    <ignoreWarnings>true|false</ignoreWarnings>
    <warnAll>true|false</warnAll>
    <warningsAsErrors>true|false</warningsAsErrors>
    <config></config>
    <fullPath>true|false</fullPath>
    <showAll>true|false</showAll>
    <disableSourceLines>true|false</disableSourceLines>
    <url>none|a=b</url>
    <enableHtml>true|false</enableHtml>
    <htmlOutputPath>${project.build.directory}/lint-results/lint-results-html/</htmlOutputPath>
    <enableSimpleHtml>true|false</enableSimpleHtml>
    <simpleHtmlOutputPath>${project.build.directory}/lint-results/lint-results-simple-html
    </simpleHtmlOutputPath>
    <enableXml>true|false</enableXml>
    <xmlOutputPath>${project.build.directory}/lint-results/lint-results.xml</xmlOutputPath>
    <enableSources>true|false</enableSources>
    <sources>${project.build.sourceDirecory}}</sources>
    <enableClasspath>true|false</enableClasspath>
    <classpath>${project.build.outputDirectory}</classpath>
    <enableLibraries>true|false</enableLibraries>
    <libraries></libraries>
</lint>
Alternatively to the plugin configuration values can also be configured as properties on the command line as android.lint.* or in pom or settings file as properties like lint*.
  • Type: com.simpligility.maven.plugins.android.configuration.Lint
  • Required: No

lintClasspath:

Add the given folder (or jar file, or path) as a class directory for the project. Only valid when running lint on a single project. Defaults to ${project.build.outputDirectory}. Consequently, the lint output depends on the phase during which this goal is executed, whether project has been compiled or not.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.classpath

lintConfig:

Use the given configuration file to determine whether issues are enabled or disabled. Defaults is "null" so no config file will be used. To use the commonly used lint.xml in the project root set the parameter to "${project.basedir}/lint.xml".
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.config

lintDisableSourceLines:

Do not include the source file lines with errors in the output. By default, the error output includes snippets of source code on the line containing the error, but this flag turns it off. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.disableSourceLines

lintEnableClasspath:

Enable including classpath into lint analysis. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableSources

lintEnableHtml:

Enable the creation of a HTML report. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableHtml

lintEnableLibraries:

Enable including libraries into lint analysis. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableSources

lintEnableSimpleHtml:

Enable the creation of a simple HTML report. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableSimpleHtml

lintEnableSource:

Enable including sources into lint analysis. Defaults to "true".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableSources

lintEnableXml:

Enable the creation of a XML report. Defaults to "true".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.enableXml

lintFailOnError:

Fail build on lint errors. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.failOnError

lintFullPath:

Use full paths in the error output. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.fullPath

lintHtmlOutputPath:

Path for the HTML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-html/.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.htmlOutputPath

lintIgnoreWarnings:

Only check for errors and ignore warnings. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.ignoreWarning

lintLibraries:

Add the given folder (or jar file, or path) as a class library for the project. Only valid when running lint on a single project. Defaults to all non provided resolved artifacts. Consequently, the lint output depends on the phase during which this goal is executed, whether project's dependencies have been resolved or not.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.libraries

lintShowAll:

Do not truncate long messages, lists of alternate locations, etc. Defaults to "true".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.showAll

lintSimpleHtmlOutputPath:

Create a simple HTML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-simple-html/.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.simpleHtmlOutputPath

lintSkip:

Skip the lint goal execution. Defaults to "true".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.skip

lintSources:

Add the given folder (or path) as a source directory for the project. Only valid when running lint on a single project. Defaults to ${project.build.sourceDirectory}.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.sources

lintUrl:

Add links to HTML report, replacing local path prefixes with url prefix. The mapping can be a comma-separated list of path prefixes to corresponding URL prefixes, such as C:\temp\Proj1=http://buildserver/sources/temp/Proj1. To turn off linking to files, use --url none. Defaults to "none".
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.url

lintWarnAll:

Check all warnings, including those off by default. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.warnAll

lintWarningsAsErrors:

Report all warnings as errors. Defaults to "false".
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.warningsAsErrors

lintXmlOutputPath:

Create an XML report. If the filename is a directory (or a new filename without an extension), lint will create a separate report for each scanned project. Defaults to ${project.build.directory}/lint/lint-results.xml.
  • Type: java.lang.String
  • Required: No
  • User Property: android.lint.xmlOutputPath

nativeLibrariesDirectory:

Root folder containing native libraries to include in the application package.

  • Type: java.io.File
  • Required: No
  • User Property: android.nativeLibrariesDirectory
  • Default: ${project.basedir}/src/main/libs

ndk:

The Android NDK to use.

Looks like this:

<ndk>
    <path>/opt/android-ndk-r4</path>
</ndk>

The <path> parameter is optional. The default is the setting of the ANDROID_NDK_HOME environment variable. The parameter can be used to override this setting with a different environment variable like this:

<ndk>
    <path>${env.ANDROID_NDK_HOME}</path>
</ndk>

or just with a hardcoded absolute path. The parameters can also be configured from command-line with parameter -Dandroid.ndk.path.

  • Type: com.simpligility.maven.plugins.android.configuration.Ndk
  • Required: No

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.
  • Type: java.io.File
  • Required: No
  • User Property: android.proguardFile

quiet:

(no description)
  • Type: java.lang.Boolean
  • Required: No
  • User Property: android.lint.quiet

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.
  • Type: boolean
  • Required: No
  • User Property: android.release
  • Default: false

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.

  • Type: java.lang.String
  • Required: No
  • User Property: android.renameManifestPackage

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.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/src/main/res

resourceOverlayDirectories:

The android resources overlay directories. If this is specified, the resourceOverlayDirectory parameter will be ignored.
  • Type: java.io.File[]
  • Required: No

resourceOverlayDirectory:

The android resources overlay directory. This will be overridden by resourceOverlayDirectories if present.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/res-overlay

sdk:

The Android SDK to use.

Looks like this:

<sdk>
    <path>/opt/android-sdk-linux</path>
    <platform>2.1</platform>
</sdk>

The <platform> parameter is optional, and corresponds to the platforms/android-* directories in the Android SDK directory. Default is the latest available version, so you only need to set it if you for example want to use platform 1.5 but also have e.g. 2.2 installed. Has no effect when used on an Android SDK 1.1. The parameter can also be coded as the API level. Therefore valid values are 1.1, 1.5, 1.6, 2.0, 2.01, 2.1, 2.2 and so as well as 3, 4, 5, 6, 7, 8... 19. If a platform/api level is not installed on the machine an error message will be produced.

The <path> parameter is optional. The default is the setting of the ANDROID_HOME environment variable. The parameter can be used to override this setting with a different environment variable like this:

<sdk>
    <path>${env.ANDROID_SDK}</path>
</sdk>

or just with a hard-coded absolute path. The parameters can also be configured from command-line with parameters -Dandroid.sdk.path and -Dandroid.sdk.platform.

  • Type: com.simpligility.maven.plugins.android.configuration.Sdk
  • Required: No

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.

  • Type: boolean
  • Required: No
  • User Property: android.undeployBeforeDeploy
  • Default: false

unpackedLibsFolder:

Folder in which AAR library dependencies will be unpacked.
  • Type: java.io.File
  • Required: No
  • User Property: unpackedLibsFolder
  • Default: ${project.build.directory}/unpacked-libs