Eclipse ivy configuration - shiraji/androidannotations GitHub Wiki
Please note that there are two important JARs in AndroidAnnotations:
-
androidannotations-X.X.X-api.jar
is the API JAR, it must be in your build path and will be part of the final APK -
androidannotations-X.X.X.jar
is the processor JAR, it is only needed at compile time, and must be in the compiler classpath.
- Eclipse 3.8 or superior
- [
ivy-ide
plugin] (http://www.apache.org/dist/ant/ivyde/updatesite) 2.2 or superior.
Add the following
- Create the ivy manifest in the root of your project
<ivy-module xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="2.0"
xsi:noNamespaceSchemaLocation="http://ant.apache.org/ivy/schemas/ivy.xsd" >
<info
module="your-module-name"
organisation="your.organisation.namespace" >
</info>
<dependencies>
<dependency
name="androidannotations-api"
conf="default->default"
org="org.androidannotations"
rev="X.X.X" />
</dependencies>
</ivy-module>
Update the module name, the organisation and the androidannotations-api revision as necessary.
-
Add the ivy dynamic library to your project. Go to the
build path > libraries
and click theadd library
button. -
Go through the wizard:
Leave the default values:
- Resolve the dependencies.
Right click on your project and go to
Ivy > Resolve
. Now ivy is retrieving the dependencies (and the source files if available): theandroidannotations-api
jar is available in the ivy classpath container.
- Export your Ivy classpath in your apk
- Put
androidannotations-X.X.X.jar
in a different folder, such ascompile-libs
.androidannotations-X.X.X.jar
must not go in thelibs
folder. - Go to
Java Compiler
and make sure thatCompiler compliance level
is set to 1.6, otherwise the processor won't be activated - Go to
Java Compiler > Annotation Processing
and chooseEnable annotation processing
- Go to
Java Compiler > Annotation Processing > Factory Path
and add the processor JAR :androidannotations-X.X.X.jar
. - Confirm the workspace rebuild
- You can start using AndroidAnnotations
-
To check that AndroidAnnotations is activated, you should see AndroidAnnotations logs in the Eclipse Error Log (
Window > Show View > Error Log
) as soon as you save a file. If you do not see any log here, then it means AndroidAnnotations isn't activated yet. -
If AndroidAnnotations isn't activated, this may be a Java version problem. You should check that
eclipse.ini
doesn't contain-Dosgi.requiredJavaVersion=1.5
, and otherwise change it to-Dosgi.requiredJavaVersion=1.6
. -
When AndroidAnnotations is activated, You should now see any annotation problem as a regular error marker within the editor and in the Problem view.
-
Your project name should be identical to the name of the folder containing the project. When importing a project in Eclipse, the project name used is the name of the folder. Since the annotation jar is referenced by
projectName/lib/androidannotations-X.X.X.jar
, you may otherwise encounter errors when coworkers import your project.
- Start using AndroidAnnotations