aboutsummaryrefslogtreecommitdiff
path: root/src/lombok/Setter.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/lombok/Setter.java')
-rw-r--r--src/lombok/Setter.java43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/lombok/Setter.java b/src/lombok/Setter.java
index b00d4158..9774c5c6 100644
--- a/src/lombok/Setter.java
+++ b/src/lombok/Setter.java
@@ -1,3 +1,24 @@
+/*
+ * Copyright © 2009 Reinier Zwitserloot and Roel Spilker.
+ *
+ * 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;
import java.lang.annotation.ElementType;
@@ -5,8 +26,30 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * Put on any field to make lombok build a standard setter.
+ *
+ * Example:
+ * <pre>
+ * private @Setter int foo;
+ * </pre>
+ *
+ * will generate:
+ *
+ * <pre>
+ * public void setFoo(int foo) {
+ * this.foo = foo;
+ * }
+ * </pre>
+ *
+ * If any method named <code>setFoo</code> exists, regardless of return type or parameters, no method is generated,
+ * and instead a compiler warning is emitted.
+ */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface Setter {
+ /**
+ * If you want your setter to be non-public, you can specify an alternate access level here.
+ */
lombok.AccessLevel value() default lombok.AccessLevel.PUBLIC;
}