com.simpligility.maven.plugins.android.phase01generatesources

Class GenerateSourcesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.simpligility.maven.plugins.android.AbstractAndroidMojo

com.simpligility.maven.plugins.android.phase01generatesources.GenerateSourcesMojo

All Implemented Interfaces:

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

@Mojo(name="generate-sources",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE)
public class GenerateSourcesMojo
extends AbstractAndroidMojo

Generates R.java based on resources specified by the resources configuration parameter. Generates java files based on aidl files.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected File	aidlSourceDirectory The directory containing the aidl files.
protected BuildConfigConstant[]	buildConfigConstants Parameter designed to generate custom BuildConfig constants
protected static List<String>	EXCLUDED_DEPENDENCY_SCOPES_FOR_EXTRACTION Which dependency scopes should not be included when unpacking dependencies
protected File	genDirectoryAidl Override default generated folder containing aidl classes
protected boolean	warnOnApklibDependencies Whether to produce a warning if there is an aar dependency that has an apklib artifact in its dependency tree.

Fields inherited from class com.simpligility.maven.plugins.android.AbstractAndroidMojo

aaptExtraArgs, aaptVerbose, adbConnectionTimeout, androidManifestFile, assetsDirectory, attachJar, attachSources, combinedAssets, configurations, customPackage, dependencyGraphBuilder, destinationManifestFile, device, devices, deviceThreads, ENV_ANDROID_HOME, ENV_ANDROID_NDK_HOME, execution, extractedDependenciesDirectory, extractedDependenciesJavaResources, extractedDependenciesJavaSources, finalName, genDirectory, generateApk, ips, nativeLibrariesDirectory, ndkOutputDirectory, proguardFile, project, projectHelper, projectOutputDirectory, release, renameManifestPackage, resourceDirectory, resourceOverlayDirectories, resourceOverlayDirectory, resources, session, sourceDirectory, sourceEncoding, SUPPORTED_PACKAGING_TYPES, targetDirectory, undeployBeforeDeploy

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateSourcesMojo()

Method Summary

Modifier and Type	Method and Description
protected void	copyManifest() Copy the AndroidManifest.xml from androidManifestFile to destinationManifestFile
void	execute() Generates the sources.
protected void	extractSourceDependencies() Extract the source dependencies.

Methods inherited from class com.simpligility.maven.plugins.android.AbstractAndroidMojo

copyFolder, deployApk, deployBuiltApk, deployDependencies, doWithDevices, extractInstrumentationRunnerFromAndroidManifest, extractPackageNameFromAndroidArtifact, extractPackageNameFromAndroidManifest, extractPackageNameFromAndroidManifestXmlTree, extractPackageNameFromApk, getAndroidManifestPackageName, getAndroidNdk, getAndroidSdk, getArtifactResolverHelper, getDependencyResolver, getDirectDependencyArtifacts, getJack, getLibraryUnpackDirectory, getNativeHelper, getRelevantCompileArtifacts, getResourceOverlayDirectories, getTransitiveDependencyArtifacts, getTransitiveDependencyArtifacts, getUnpackedAarClassesJar, getUnpackedApkLibSourceFolder, getUnpackedLibAssetsFolder, getUnpackedLibFolder, getUnpackedLibHelper, getUnpackedLibNativesFolder, getUnpackedLibResourceFolder, getUnpackedLibsDirectory, initAndroidDebugBridge, isAPKBuild, isInstrumentationTest, resolveArtifactToFile, undeployApk, undeployApk, waitForInitialDeviceList

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

Field Detail

warnOnApklibDependencies

@Parameter(defaultValue="true")
protected boolean warnOnApklibDependencies

Whether to produce a warning if there is an aar dependency that has an apklib artifact in its dependency tree. The combination of aar library including or depending on an apklib has been deprecated and may not be supported by future plugin versions. Traversing the dependency graph is done for all project dependencies present in build classpath.

It is recommended to keep this set to true to catch possible issues as soon as possible.

genDirectoryAidl

@Parameter(property="android.genDirectoryAidl",
           defaultValue="${project.build.directory}/generated-sources/aidl")
protected File genDirectoryAidl

Override default generated folder containing aidl classes

aidlSourceDirectory

@Parameter(property="android.aidlSourceDirectory",
           defaultValue="${project.basedir}/src/main/aidl")
protected File aidlSourceDirectory

The directory containing the aidl files.

buildConfigConstants

@Parameter(property="android.buildConfigConstants")
protected BuildConfigConstant[] buildConfigConstants

Parameter designed to generate custom BuildConfig constants

EXCLUDED_DEPENDENCY_SCOPES_FOR_EXTRACTION

protected static final List<String> EXCLUDED_DEPENDENCY_SCOPES_FOR_EXTRACTION

Which dependency scopes should not be included when unpacking dependencies

Constructor Detail

GenerateSourcesMojo

public GenerateSourcesMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Generates the sources.

Throws:

org.apache.maven.plugin.MojoExecutionException - if it fails.

org.apache.maven.plugin.MojoFailureException - if it fails.

copyManifest

protected void copyManifest()
                     throws org.apache.maven.plugin.MojoExecutionException

Copy the AndroidManifest.xml from androidManifestFile to destinationManifestFile

Throws:

org.apache.maven.plugin.MojoExecutionException

extractSourceDependencies

protected void extractSourceDependencies()
                                  throws org.apache.maven.plugin.MojoExecutionException

Extract the source dependencies.

Throws:

org.apache.maven.plugin.MojoExecutionException - if it fails.