aboutsummaryrefslogtreecommitdiff
path: root/website/templates
diff options
context:
space:
mode:
Diffstat (limited to 'website/templates')
-rw-r--r--website/templates/features/Data.html4
-rw-r--r--website/templates/features/Value.html4
-rw-r--r--website/templates/features/constructor.html4
-rw-r--r--website/templates/setup/ecj-in-maven-pom-example.xml81
-rw-r--r--website/templates/setup/ecj.html3
5 files changed, 93 insertions, 3 deletions
diff --git a/website/templates/features/Data.html b/website/templates/features/Data.html
index 36278819..f8a6c4d9 100644
--- a/website/templates/features/Data.html
+++ b/website/templates/features/Data.html
@@ -26,6 +26,10 @@
<code>lombok.data.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
</dt><dd>
Lombok will flag any usage of <code>@Data</code> as a warning or error if configured.
+ </dd><dt>
+ <code>lombok.noArgsConstructor.extraPrivate</code> = [<code>true</code> | <code>false</code>] (default: false)
+ </dt><dd>
+ If <code>true</code>, lombok will generate a private no-args constructor for any <code>@Data</code> annotated class, which sets all fields to default values (null / 0 / false).
</dd>
</@f.confKeys>
diff --git a/website/templates/features/Value.html b/website/templates/features/Value.html
index f6ef9403..c41b6b10 100644
--- a/website/templates/features/Value.html
+++ b/website/templates/features/Value.html
@@ -30,9 +30,9 @@
</dt><dd>
Lombok will flag any usage of <code>@Value</code> as a warning or error if configured.
</dd><dt>
- <code>lombok.val.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
+ <code>lombok.noArgsConstructor.extraPrivate</code> = [<code>true</code> | <code>false</code>] (default: false)
</dt><dd>
- Lombok will flag any usage of <code>val</code> as a warning or error if configured.
+ If <code>true</code>, lombok will generate a private no-args constructor for any <code>@Value</code> annotated class, which sets all fields to default values (null / 0 / false).
</dd>
</@f.confKeys>
diff --git a/website/templates/features/constructor.html b/website/templates/features/constructor.html
index 02380319..f9ee775d 100644
--- a/website/templates/features/constructor.html
+++ b/website/templates/features/constructor.html
@@ -42,6 +42,10 @@
<code>lombok.copyableAnnotations</code> = [<em>A list of fully qualified types</em>] (default: empty list)
</dt><dd>
Lombok will copy any of these annotations from the field to the constructor parameter, the setter parameter, and the getter method. Note that lombok ships with a bunch of annotations 'out of the box' which are known to be copyable: All popular nullable/nonnull annotations.
+ </dd><dt>
+ <code>lombok.noArgsConstructor.extraPrivate</code> = [<code>true</code> | <code>false</code>] (default: false)
+ </dt><dd>
+ If <code>true</code>, lombok will generate a private no-args constructor for any <code>@Value</code> or <code>@Data</code> annotated class, which sets all fields to default values (null / 0 / false).
</dd>
</@f.confKeys>
diff --git a/website/templates/setup/ecj-in-maven-pom-example.xml b/website/templates/setup/ecj-in-maven-pom-example.xml
new file mode 100644
index 00000000..3bb10722
--- /dev/null
+++ b/website/templates/setup/ecj-in-maven-pom-example.xml
@@ -0,0 +1,81 @@
+<#noparse>
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.projectlombok</groupId>
+ <artifactId>eclipse-compiler-test</artifactId>
+ <version>1.0-SNAPSHOT</version>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+</#noparse>
+ <lombok.version>${version}</lombok.version>
+<#noparse>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>3.8.1</version>
+ <configuration>
+ <compilerId>eclipse</compilerId>
+ <release>11</release>
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-compiler-eclipse</artifactId>
+ <version>2.8.6</version>
+ </dependency>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <version>3.1.1</version>
+ <executions>
+ <execution>
+ <id>get-lombok</id>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ <type>jar</type>
+ <outputDirectory>${project.build.directory}</outputDirectory>
+ <destFileName>lombok.jar</destFileName>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+</project>
+</#noparse>
diff --git a/website/templates/setup/ecj.html b/website/templates/setup/ecj.html
index 9d56a085..e01bc653 100644
--- a/website/templates/setup/ecj.html
+++ b/website/templates/setup/ecj.html
@@ -15,12 +15,13 @@
<@s.section title="Maven">
<p>
- It is possible to <a href="/files/pom.xml">configure</a> <code>maven-compiler-plugin</code> with <code>maven-dependency-plugin</code> and <code>plexus-compiler-eclipse</code>.
+ It is possible to <a href="/setup/ecj-in-maven-pom-example.xml">configure</a> <code>maven-compiler-plugin</code> with <code>maven-dependency-plugin</code> and <code>plexus-compiler-eclipse</code>.
</p><p>
Before the <code>compile</code> phase, you will have to set your <code>MAVEN_OPTS</code> environment variable to include the <code>javaagent</code> argument. In the example below, <code>target</code> is your <code>${r"${project.build.directory}"}</code>.
</p><p>
Use the following commands in sequence to enable lombok with ecj in your Maven build:
<pre>
+# Make sure you've updated your pom as per <a href="/setup/ecj-in-maven-pom-example.xml">this example</a>.
mvn clean <strong>dependency:copy@get-lombok</strong>
set MAVEN_OPTS=<strong>-javaagent:target/lombok.jar=ECJ</strong> <em class="note">(or your OS's equivalent)</em>
mvn install