From 8b7a7cbc813653a3248d6cf3a7779e220957bc85 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 8 May 2017 21:28:02 +0200 Subject: The great rename: the old ‘website’ is now ‘website-old’, and ‘website2’ is now ‘website’. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website2/templates/features/experimental/onX.html | 62 ----------------------- 1 file changed, 62 deletions(-) delete mode 100644 website2/templates/features/experimental/onX.html (limited to 'website2/templates/features/experimental/onX.html') diff --git a/website2/templates/features/experimental/onX.html b/website2/templates/features/experimental/onX.html deleted file mode 100644 index fd2e7b58..00000000 --- a/website2/templates/features/experimental/onX.html +++ /dev/null @@ -1,62 +0,0 @@ -<#import "../_features.html" as f> - -<@f.scaffold title="onX" logline="Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating."> - <@f.history> -

- onX was introduced as experimental feature in lombok v0.11.8. -

- - - <@f.experimental> - - Current status: uncertain - Currently we feel this feature cannot move out of experimental status. - - - <@f.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. @EqualsAndHashCode also supports onParam; the listed annotation(s) will be placed on the single parameter of the generated equals method, as well as any generated canEqual method. -

- The syntax is a little strange and depends on the javac you are using.
- On javac7, to use any of the 3 onX features, you must wrap the annotations to be applied to the constructor / method / parameter in @__(@AnnotationGoesHere). To apply multiple annotations, use @__({@Annotation1, @Annotation2}). The annotations can themselves obviously have parameters as well.
- On javac8 and up, you add an underscore after onMethod, onParam, or onConstructor. -

- - - <@f.snippets name="experimental/onX" /> - - <@f.confKeys> -
- lombok.onX.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of onX as a warning or error if configured. -
- - - <@f.smallPrint> -

- The reason of the weird syntax is to make this feature work in javac 7 compilers; the @__ type is an annotation reference to the annotation type __ (double underscore) which doesn't actually exist; this makes javac 7 delay aborting the compilation process due to an error because it is possible an annotation processor will later create the __ type. Instead, lombok applies the annotations and removes the references so that the error will never actually occur. The point is: The __ type must not exist, otherwise the feature does not work. In the rare case that the __ type does exist (and is imported or in the package), you can simply add more underscores. Technically any non-existent type would work, but to maintain consistency and readability and catch erroneous use, lombok considers it an error if the 'wrapper' annotation is anything but a series of underscores. -

- In javac8, the above feature should work but due to a bug in javac8 it does not. However, starting in javac8, if the parameter name does not exist in the annotation type, compilation proceeds to a phase where lombok can fix it. -

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

- The onX parameter is not legal on any type-wide variant. For example, a @Getter annotation on a class does not support onMethod. -

- - -- cgit