aboutsummaryrefslogtreecommitdiff
path: root/src/lombok/Lombok.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/lombok/Lombok.java')
-rw-r--r--src/lombok/Lombok.java29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/lombok/Lombok.java b/src/lombok/Lombok.java
index 10a58e5a..400bf3ea 100644
--- a/src/lombok/Lombok.java
+++ b/src/lombok/Lombok.java
@@ -1,5 +1,29 @@
+/*
+ * 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;
+/**
+ * Useful utility methods to manipulate lombok-generated code.
+ */
public class Lombok {
/**
* Throws any throwable 'sneakily' - you don't need to catch it, nor declare that you throw it onwards.
@@ -15,6 +39,11 @@ public class Lombok {
* about the concept of a 'checked exception'. All this method does is hide the act of throwing a checked exception
* from the java compiler.
*
+ * Note that this method has a return type of <code>RuntimeException</code> it is advised you always call this
+ * method as argument to the <code>throw</code> statement to avoid compiler errors regarding no return
+ * statement and similar problems. This method won't of course return an actual <code>RuntimeException</code> -
+ * it never returns, it always throws the provided exception.
+ *
* @param t The throwable to throw without requiring you to catch its type.
* @return A dummy RuntimeException; this method never returns normally, it <em>always</em> throws an exception!
*/