aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@tipit.to>2009-08-27 23:05:02 +0200
committerReinier Zwitserloot <reinier@tipit.to>2009-08-27 23:05:02 +0200
commite6bb460e2b1ba49698e5306ddcb5ce38748e2dfc (patch)
tree9c96e03bd30800035b08cd67208ff0e470c0d35a
parent388943a7e3c8d3cf64b44af045d4d3125b597444 (diff)
downloadlombok-e6bb460e2b1ba49698e5306ddcb5ce38748e2dfc.tar.gz
lombok-e6bb460e2b1ba49698e5306ddcb5ce38748e2dfc.tar.bz2
lombok-e6bb460e2b1ba49698e5306ddcb5ce38748e2dfc.zip
Added javadoc and copyright header.
-rw-r--r--src/lombok/NonNull.java33
1 files changed, 30 insertions, 3 deletions
diff --git a/src/lombok/NonNull.java b/src/lombok/NonNull.java
index d63407f0..46afc5da 100644
--- a/src/lombok/NonNull.java
+++ b/src/lombok/NonNull.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,14 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * Lombok is smart enough to translate any annotation named <code>@NonNull</code> or <code>@NotNull</code> in any casing and
+ * with any package name to the return type of generated getters and the parameter of generated setters and constructors,
+ * as well as generate the appropriate null checks in the setter and constructor.
+ *
+ * You can use this annotation for the purpose, though you can also use JSR305's annotation, findbugs's, pmd's, or IDEA's, or just
+ * about anyone elses. As long as it is named <code>@NonNull</code> or <code>@NotNull</code>.
+ */
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE})
@Retention(RetentionPolicy.CLASS)
-public @interface NonNull {
-
-}
+public @interface NonNull {}