From 8850798a04e7f44925ed16b3450623b02f5b6295 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 13 Aug 2012 00:11:02 +0200 Subject: Documentation for @Value, @FieldDefaults, @Wither --- website/features/experimental/FieldDefaults.html | 84 ++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 website/features/experimental/FieldDefaults.html (limited to 'website/features/experimental/FieldDefaults.html') diff --git a/website/features/experimental/FieldDefaults.html b/website/features/experimental/FieldDefaults.html new file mode 100644 index 00000000..94c23a27 --- /dev/null +++ b/website/features/experimental/FieldDefaults.html @@ -0,0 +1,84 @@ + + + + + + + + EXPERIMENTAL - @FieldDefaults +
+
+
+ +

@FieldDefaults

+ +
+

Since

+

+ @FieldDefaults was introduced as experimental feature in lombok v0.11.4. +

+
+
+

Experimental

+

+ Experimental because: +

    +
  • New feature; unsure if this busts enough boilerplate
  • +
  • Would be nice if you could stick this on the package-info.java package to set the default for all classes in that package
  • +
  • Part of the work on @Value, which is experimental
  • +
+ Current status: positive - Currently we feel this feature may move out of experimental status with no or minor changes soon. +
+
+

Overview

+

+ The @FieldDefaults annotation can add an access modifier (public, private, or protected) + to each field in the annotated class or enum. It can also add final to each field in the annotated class or enum. +

+

+ To add final to each field, use @FieldDefaults(makeFinal=true). Any non-final field which must remain nonfinal + can be annotated with @NonFinal (also in the lombok.experimental package). +

+ To add an access modifier to each field, use @FieldDefaults(level=AccessLevel.PRIVATE). Any field that does not already have an + access modifier (i.e. any field that looks like package private access) is changed to have the appropriate access modifier. Any package private + field which must remain package private can be annotated with @PackagePrivate (also in the lombok.experimental package). +

+
+
+
+

With Lombok

+
@HTML_PRE@
+
+
+
+

Vanilla Java

+
@HTML_POST@
+
+
+
+
+

Small print

+

+ Like other lombok handlers that touch fields, any field whose name starts with a dollar ($) symbol is skipped entirely. + Such a field will not be modified at all. +

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