Building Project Maven Eclipse

Note

• Please read the Configuration page first
• Looking for an example? See this project.

Creating / importing a project

Follow the Getting Started page of the m2eclipse-android-integration plugin to create / import your project as a Maven + Android project.

Eclipse configuration

The Maven configuration enables AndroidAnnotations usage from the command line (e.g using mvn package). However, since Eclipse uses its own compiler, you also need to configure it.

You can configure Eclipse in three different ways:

• Using the m2e-apt eclipse plugin
• Manual configuration pointing to your local Maven Repo
• Manual configuration pointing to a downloaded Jar with dependencies

Option 1: Using the m2e-apt eclipse plugin

The m2e-apt handles Eclipse configuration for you. We know it works fine with Eclipse Juno, however you may run into troubles with previous Eclipse versions.

• Install Maven Integration for Eclipse JDT APT (m2e-apt plugin) from the m2e-apt update site: http://download.jboss.org/jbosstools/updates/m2e-extensions/m2e-apt
• Right-click your project, choose Properties
• Go to Maven > Annotation Processing
• Check Enable project specific settings
• Select Automatically configure JDT APT
• Select Project > Clean... and run a clean build of your project

Option 2: Manual configuration pointing to your local Maven Repo

• Right-click your project, choose Properties
• Go to Java Compiler > Annotation Processing and choose Enable annotation processing
• Go to Java Compiler > Annotation Processing > Factory Path
• Click on Add Variable, select M2_REPO and click on Extend...; then, select the following JAR : com/googlecode/androidannotations/androidannotations-api/X.X/androidannotations-api-X.X.jar
• Click on Add Variable, select M2_REPO and click on Extend...; then, select the following JAR : com/sun/codemodel/codemodel/2.4.1/codemodel-2.4.1.jar
• Click on Add Variable, select M2_REPO and click on Extend...; then, select the following JAR : com/googlecode/androidannotations/androidannotations/X.X/androidannotations-X.X.jar
• Confirm the workspace rebuild

The previous manual configuration can also be created by adding the following files at the root of your project:

• .factorypath

<factorypath>
    <factorypathentry kind="PLUGIN" id="org.eclipse.jst.ws.annotations.core" enabled="true" runInBatchMode="false"/>
    <factorypathentry kind="VARJAR" id="M2_REPO/com/googlecode/androidannotations/androidannotations/X.X/androidannotations-X.X.jar" enabled="true" runInBatchMode="false"/>
    <factorypathentry kind="VARJAR" id="M2_REPO/com/googlecode/androidannotations/androidannotations-api/X.X/androidannotations-api-X.X.jar" enabled="true" runInBatchMode="false"/>
    <factorypathentry kind="VARJAR" id="M2_REPO/com/sun/codemodel/codemodel/2.4.1/codemodel-2.4.1.jar" enabled="true" runInBatchMode="false"/>
</factorypath>

• .settings/org.eclipse.jdt.apt.core.prefs

eclipse.preferences.version=1
org.eclipse.jdt.apt.aptEnabled=true
org.eclipse.jdt.apt.genSrcDir=.apt_generated
org.eclipse.jdt.apt.reconcileEnabled=true

Option 3: Manual configuration pointing to a downloaded Jar with dependencies

This configuration is similar to the configuration of the processor in Eclipse without Maven. The androidannotations-X.X.jar jar in the bundle already contains androidannotations-api-X.X.jar and codemodel-2.4.1.jar

• Download the zip bundle
• Put androidannotations-X.X.X.jar in a specific folder, such as compile-libs
• Right-click your project, choose Properties Go to Java Compiler > Annotation Processing and choose Enable annotation processing
• Go to Java Compiler > Annotation Processing > Factory Path and add the processor JAR : androidannotations-X.X.X.jar.
• Confirm the workspace rebuild

Next step

• Start using AndroidAnnotations

Troubleshooting

Please read the Troubleshooting section of the Eclipse configuration page.