From aaf8547d91a540334419f2faebb897b327d535d8 Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <reinier@zwitserloot.com>
Date: Tue, 20 Jul 2010 07:43:02 +0200
Subject: Added documentation for @RequiredArgsConstructor, @NoArgsConstructor,
 @AllArgsConstructor, and also how these generate @ConstructorProperties
 annotations.

Also updated @Getter and @Setter's documentation to explain their new class-level feature, and updated @Data's description to highlight how @Data is now truly nothing more than the combination of @RequiredArgsConstructor, @EqualsAndHashCode, @ToString, @Getter, and @Setter.
---
 usage_examples/ConstructorExample_post.jpage | 30 ++++++++++++++++++++++++++++
 usage_examples/ConstructorExample_pre.jpage  | 16 +++++++++++++++
 2 files changed, 46 insertions(+)
 create mode 100644 usage_examples/ConstructorExample_post.jpage
 create mode 100644 usage_examples/ConstructorExample_pre.jpage

(limited to 'usage_examples')

diff --git a/usage_examples/ConstructorExample_post.jpage b/usage_examples/ConstructorExample_post.jpage
new file mode 100644
index 00000000..5f4aa987
--- /dev/null
+++ b/usage_examples/ConstructorExample_post.jpage
@@ -0,0 +1,30 @@
+@RequiredArgsConstructor(staticName = "of")
+@AllArgsConstructor(access = AccessLevel.PROTECTED)
+public class ConstructorExample<T> {
+	private int x, y;
+	@NonNull private T description;
+	
+	private ConstructorExample(T description) {
+		if (description == null) throw new NullPointerException("description");
+		this.description = description;
+	}
+	
+	public static <T> ConstructorExample<T> of(T description) {
+		return new ConstructorExample<T>(description);
+	}
+	
+	@java.beans.ConstructorProperties({"x", "y", "description"})
+	protected ConstructorExample(int x, int y, T description) {
+		if (description == null) throw new NullPointerException("description");
+		this.x = x;
+		this.y = y;
+		this.description = description;
+	}
+	
+	public static class NoArgsExample {
+		@NonNull private String field;
+		
+		public NoArgsExample() {
+		}
+	}
+}
diff --git a/usage_examples/ConstructorExample_pre.jpage b/usage_examples/ConstructorExample_pre.jpage
new file mode 100644
index 00000000..ac0d3c28
--- /dev/null
+++ b/usage_examples/ConstructorExample_pre.jpage
@@ -0,0 +1,16 @@
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
+import lombok.AllArgsConstructor;
+import lombok.NonNull;
+
+@RequiredArgsConstructor(staticName = "of")
+@AllArgsConstructor(access = AccessLevel.PROTECTED)
+public class ConstructorExample<T> {
+	private int x, y;
+	@NonNull private T description;
+	
+	@NoArgsConstructor
+	public static class NoArgsExample {
+		@NonNull private String field;
+	}
+}
-- 
cgit