aboutsummaryrefslogtreecommitdiff
path: root/website/features/onX.html
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2013-02-18 21:41:07 +0100
committerReinier Zwitserloot <reinier@zwitserloot.com>2013-02-18 21:41:07 +0100
commited61012f95cefae8d03260f506ffe34bc19bd90c (patch)
tree7f7478ed94a7eb423a2cd1379541c3716475efc4 /website/features/onX.html
parent1488a262bd389d0fef444bb3fd80821a2d66e6c2 (diff)
downloadlombok-ed61012f95cefae8d03260f506ffe34bc19bd90c.tar.gz
lombok-ed61012f95cefae8d03260f506ffe34bc19bd90c.tar.bz2
lombok-ed61012f95cefae8d03260f506ffe34bc19bd90c.zip
whoops, belated push and fixes to the documentation of onX
Diffstat (limited to 'website/features/onX.html')
-rw-r--r--website/features/onX.html71
1 files changed, 0 insertions, 71 deletions
diff --git a/website/features/onX.html b/website/features/onX.html
deleted file mode 100644
index ab72e6f5..00000000
--- a/website/features/onX.html
+++ /dev/null
@@ -1,71 +0,0 @@
-<!DOCTYPE html>
-<html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <link rel="stylesheet" type="text/css" href="../logi/reset.css" />
- <link rel="stylesheet" type="text/css" href="features.css" />
- <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon" />
- <meta name="description" content="Spice up your java" />
- <title>onX</title>
-</head><body><div id="pepper">
- <div class="minimumHeight"></div>
- <div class="meat">
- <div class="header"><a href="../index.html">Project Lombok</a></div>
- <h1>onX</h1>
- <div class="byline">Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating.</div>
- <div class="overview">
- <h3>Overview</h3>
- <p>
- <strong>This feature is considered 'workaround status' - it exists in order to allow users of lombok that cannot work without this feature to have access to it anyway. If we find a better way to implement this feature, or some future java version introduces an alternative strategy, this feature can disappear without a reasonable deprecation period. Also, this feature may not work in future versions of javac. Use at your own discretion.</strong>
- </p><p>
- Most annotations that make lombok generate methods or constructors can be configured to also
- make lombok put custom annotations on elements in the generated code.
- </p><p>
- <code>@Getter</code>, <code>@Setter</code>, and <code>@Wither</code> support the <code>onMethod</code>
- option, which will put the listed annotations on the generated method.
- </p><p>
- <code>@AllArgsConstructor</code>, <code>@NoArgsConstructor</code>, and <code>@RequiredArgsConstructor</code> support the <code>onConstructor</code> option which will put the listed annotations on the generated constructor.
- </p><p>
- <code>@Setter</code> and <code>@Wither</code> support <code>onParam</code> in addition to <code>onMethod</code>; annotations listed will be put on the only parameter that the generated method has.
- </p><p>
- None of the mentioned annotations above actually have parameters named <code>onMethod</code>, <code>onParam</code>, or <code>onConstructor</code>; nevertheless, if you type them, lombok will make it work. Unfortunately this does mean that auto-complete and other tool-driven convenience features will not work as expected. The annotations lack these parameters in order to work around javac limitations.
- </p>
- </div>
- <div class="snippets">
- <div class="pre">
- <h3>With Lombok</h3>
- <div class="snippet">@HTML_PRE@</div>
- </div>
- <div class="sep"></div>
- <div class="post">
- <h3>Vanilla Java</h3>
- <div class="snippet">@HTML_POST@</div>
- </div>
- </div>
- <div style="clear: left;"></div>
- <div class="overview">
- <h3>Small print</h3><div class="smallprint">
- <p>
- We can't think of any small print for this feature, other than to reiterate: This feature can disappear at any time; if you use this feature, be prepared to adjust your code when we find a nicer way of implementing this feature, or, if a future version of javac forces us to remove this feature entirely with no alternative.
- </p><p>
- The <code>onX</code> parameter is not legal on any type-wide variant. For example, a <code>@Getter</code> annotation on a class does not support <code>onMethod</code>.
- </p>
- </div>
- </div>
- <div class="footer">
- <a href="index.html">Back to features</a><br />
- <a href="../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright &copy; 2009-2013 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span>
- </div>
- <div style="clear: both;"></div>
- </div>
-</div>
-<script type="text/javascript">
- var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
- document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-</script>
-<script type="text/javascript">
- try {
- var pageTracker = _gat._getTracker("UA-9884254-1");
- pageTracker._trackPageview();
- } catch(err) {}
-</script>
-</body></html>