From ef8769d3180b2c6de91a64f69dfa23a2e6e449b9 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Sat, 17 Nov 2012 20:26:58 +0100 Subject: Added all documentation for the onX feature and updated changelog. Now to actually write the feature (Well, rescue it from the onX-removal tag). --- website/features/onX.html | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 website/features/onX.html (limited to 'website/features/onX.html') diff --git a/website/features/onX.html b/website/features/onX.html new file mode 100644 index 00000000..b001f294 --- /dev/null +++ b/website/features/onX.html @@ -0,0 +1,69 @@ + + + + + + + + onX +
+
+
+ +

onX

+ +
+

Overview

+

+ 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. +

+ 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. +

+ @Getter, @Setter, and @Wither support the onMethod + option, which will put the listed annotations on the generated method. +

+ @AllArgsConstructor, @NoArgsConstructor, and @RequiredArgsConstructor support the onConstructor option which will put the listed annotations on the generated constructor. +

+ @Setter and @Wither support onParam in addition to onMethod; annotations listed will be put on the only parameter that the generated method has. +

+ None of the mentioned annotations above actually have parameters named onMethod, onParam, or onConstructor; 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. +

+
+
+
+

With Lombok

+
@HTML_PRE@
+
+
+
+

Vanilla Java

+
@HTML_POST@
+
+
+
+
+

Small print

+

+ 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. +

+
+
+ +
+
+
+ + + -- cgit