Project Lombok - android instructions

- -

- Version: @VERSION@ | changelog -

- Android development with lombok is possible. Lombok should be a compile-time only dependency, as otherwise - the entirety of lombok will end up in your DEX files, wasting precious space on android devices. Also, errors will occur due - to the native libraries present in lombok.jar itself. Unfortunately, android does not (yet) understand the concept of a - compile-time-only dependency, so you need to mess with your build files to make it work. -

- Android also does not have a complete JRE library stack; in particular, it does not have the @java.beans.ConstructorProperties annotation, therefore you have to stop lombok from generating these: -

The suppressConstructorProperties property can be set to false when using @XArgsConstructor Annotations.
Starting with Lombok >= 1.14.0 you can instead a lombok.config file to the root of your project to disable ConstructorProperties project wide. Add the following line to lombok.config:
-
```
lombok.anyConstructor.suppressConstructorProperties = true
```
- See the configuration documentation for more information on how to set up your project with a lombok config file. -

- The instructions listed below are excerpts from The - AndroidAnnotations project cookbook. You may wish to refer to that documentation for complete instructions; lombok is just - the equivalent to androidannotations-VERSION.jar; there is no -api aspect. -

Eclipse

- In eclipse, create a 'lightweight' lombok jar that contains only the annotations by running:

-

-java -jar lombok.jar publicApi

- Then, add the lombok-api.jar file created by running this command - to your android project instead of the complete lombok.jar, and, - as usual, install lombok into eclipse by double-clicking lombok.jar. -

Ant

Find build.xml in ${ANDROID_SDK_ROOT}/tools/ant/build.xml and copy the -compile target into the paste buffer. -
Copy this to the build.xml of your own project, right before the <import file="${sdk.dir}/tools/ant/build.xml"> line. -
Create a compile-libs directory in your own project and copy the complete lombok.jar to it. -
Now modify the <classpath> entry inside the <javac> task in the -compile target you just copied:
- add <fileset dir="compile-libs" includes="*.jar" /> to it. -

Maven

- You should be able to just follow the normal lombok with maven instructions.
- Note that if you use android, eclipse, and maven together you may have to replace lombok.jar in your eclipse android project's build path - (which you can modify in that project's properties page) with lombok-api.jar, as produced in the procedure explained for Eclipse, - above. -

Gradle

Make sure that the version of your android plugin is >= 0.4.3
Add Lombok to your application's dependencies block:

-
```
-	provided "org.projectlombok:lombok:1.12.6"
-
```
-
When using android-apt, you also have to specify Lombok as an annotation processor (with the apt directive) in the dependencies block:

-
```
-	provided "org.projectlombok:lombok:1.12.6"
-	apt "org.projectlombok:lombok:1.12.6"
-
```
-

Android Studio

- Follow the previous instructions (Gradle). In addition to setting up your gradle project correctly, you need to add the Lombok IntelliJ plugin to add lombok support to Android Studio: -

Go to File > Settings > Plugins
Click on Browse repositories...
Search for Lombok Plugin
Click on Install plugin
Restart Android Studio

- -

- - - diff --git a/website/setup/ecj.html b/website/setup/ecj.html deleted file mode 100644 index cc70c566..00000000 --- a/website/setup/ecj.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - - Project Lombok - - -

Project Lombok - ecj instructions

- -

- -

- Version: @VERSION@ | changelog -

- ecj (the eclipse standalone compiler) is compatible with lombok. Use the following command line to enable lombok with ecj: -

java -javaagent:lombok.jar=ECJ -jar ecj.jar -cp lombok.jar -source 1.8 (rest of arguments)

- You may have to add the following VM argument, if you're using an older version of lombok or java: -

-Xbootclasspath/p:lombok.jar

- If you're using a tool based on ecj, adding these VM arguments and adding lombok.jar to the classpath should work. -

Using ecj with Maven

- It is possible to configure maven-compiler-plugin with maven-dependency-plugin and plexus-compiler-eclipse. -

- Before the compile phase, you will have to set your MAVEN_OPTS environment variable to include the javaagent argument. - In the example below, target is your ${project.build.directory}. -

- Use the following commands in sequence to enable lombok with ecj in your Maven build: -

-mvn clean dependency:copy@get-lombok
-set MAVEN_OPTS=-javaagent:target/lombok.jar=ECJ (or your OS's equivalent)
-mvn install
-set MAVEN_OPTS= (or your OS's equivalent)
-

- -

- - - diff --git a/website/setup/gwt.html b/website/setup/gwt.html deleted file mode 100644 index d7bcad56..00000000 --- a/website/setup/gwt.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - - Project Lombok - - -

Project Lombok - gwt instructions

- -

- -

- Version: @VERSION@ | changelog -

- gwt (Google Web Toolkit) is compatible with lombok. -

- Edit your proj-debug and proj-compile batch scripts to add the following VM arguments: -

-java -javaagent:lombok.jar=ECJ (rest of arguments)
-

- Thanks to Stephen Haberman for figuring this out. -

- -

- - - diff --git a/website/setup/netbeans-enable-annotation-processing-in-editor.png b/website/setup/netbeans-enable-annotation-processing-in-editor.png deleted file mode 100644 index d8a6b4c3..00000000 Binary files a/website/setup/netbeans-enable-annotation-processing-in-editor.png and /dev/null differ diff --git a/website/setup/netbeans.html b/website/setup/netbeans.html deleted file mode 100644 index 4ef1d392..00000000 --- a/website/setup/netbeans.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - - Project Lombok - - -

Project Lombok - NetBeans instructions

- -

- -