Documentation for new @Accessors feature as well as the API (the annotation in experimental package).

1 files changed, 56 insertions, 0 deletions

diff --git a/src/core/lombok/experimental/Accessors.java b/src/core/lombok/experimental/Accessors.java
new file mode 100644
index 00000000..5b454273
--- /dev/null
+++ b/src/core/lombok/experimental/Accessors.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2012 The Project Lombok Authors.
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package lombok.experimental;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * A container for settings for the generation of getters and setters.
+ * Using this annotation does nothing by itself; an annotation that makes lombok generate getters and setters,
+ * such as {@link lombok.Setter} or {@link lombok.Data} is also required.
+ */
+@Target({ElementType.TYPE, ElementType.FIELD})
+@Retention(RetentionPolicy.SOURCE)
+public @interface Accessors {
+	/**
+	 * If true, accessors will be named after the field and not include a <code>get</code> or <code>set</code>
+	 * prefix. If true and <code>chain</code> is omitted, <code>chain</code> defaults to <code>true</code>.
+	 * <strong>default: false</strong>
+	 */
+	boolean fluent() default false;
+	
+	/**
+	 * If true, setters return <code>this</code> instead of <code>void</code>.
+	 * <strong>default: false</strong>, unless <code>fluent=true</code>, then <strong>default: true</code>
+	 */
+	boolean chain() default false;
+	
+	/**
+	 * If present, only fields with any of the stated prefixes are given the getter/setter treatment.
+	 * Note that a prefix only counts if the next character is NOT a lowercase character. If multiple fields
+	 * all turn into the same name when the prefix is stripped, an error will be generated.
+	 */
+	String[] prefix() default {};
+}