docs for the redesigned FieldNameConstants.

1 files changed, 11 insertions, 11 deletions

diff --git a/website/templates/features/experimental/FieldNameConstants.html b/website/templates/features/experimental/FieldNameConstants.html
index c5e57195..a6fac99d 100644
--- a/website/templates/features/experimental/FieldNameConstants.html
+++ b/website/templates/features/experimental/FieldNameConstants.html
@@ -4,6 +4,8 @@
 	<@f.history>
 		<p>
 			@FieldNameConstants was introduced as experimental feature in lombok v1.16.22.
+		</p><p>
+			@FieldNameConstants was redesigned in lombok v1.18.4.
 		</p>
 	</@f.history>
 
@@ -18,11 +20,11 @@
 
 	<@f.overview>
 		<p>
-			The <code>@FieldNameConstants</code> annotation generates string constants (fields marked <code>public static final</code>, of type <code>java.lang.String</code>) containing the field's name, as a string. This is useful for various marshalling and serialization frameworks. The constant field by default is named <code>FIELD_<em>NAME_OF_FIELD</em></code>, where <em>NAME_OF_FIELD</em> is the same name as the field it represents, except with all uppercase letters, with underscores in front of the uppercase letters in the original field. The prefix (and suffix) is configurable on the <code>@FieldNameConstants</code> annotation.
+			The <code>@FieldNameConstants</code> annotation generates an inner type which contains 1 constant for each field in your class; either string constants (fields marked <code>public static final</code>, of type <code>java.lang.String</code>) or if you prefer, an enum type with 1 value for each field. <code>@FieldNameConstants</code> is useful for various marshalling and serialization frameworks. The constant field (whether enum value or string constant) always has the exact same name as the field, capitalization and all.
 		</p><p>
-			The <code>public</code> access modifier can be changed via the parameter <code>level = AccessLevel.PACKAGE</code> for example. You can force a field to be skipped by supplying <code>level = AccessLevel.NONE</code>.
+			The generated inner type is by default called <code>Fields</code> and is <code>public</code>. You can modify this via <code>@FieldNameConstants(innerTypeName = "FieldNames", access = AccessLevel.PACKAGE)</code> for example. The default inner type name can also be modified via configuration key <code>lombok.fieldNameConstants.innerTypeName</code>. The generated fields are always <code>public</code>.
 		</p><p>
-			Can be applied to classes (in which case every field gets a constant), or to an individual field.
+			Must be applied to classes (or enums, though you'd rarely want to do that). By default includes all non-transient, non-static fields. You can use <code>@FieldNameConstants.Include</code> in fields + <code>@FieldNameConstants(onlyExplicitlyIncluded = true)</code>, or <code>@FieldNameConstants.Exclude</code> for more fine-grained control.
 		</p>
 	</@f.overview>
 
@@ -34,21 +36,19 @@
 		</dt><dd>
 			Lombok will flag any usage of <code>@FieldDefaults</code> as a warning or error if configured.
 		</dd><dt>
-			<code>lombok.fieldNameConstants.prefix</code> = <em>a string</em> (default: 'PREFIX_')
-		</dt><dd>
-			Lombok will generate the name for each fieldconstant by constant-casing the field name and then prefixing this string to the result.
-		</dd><dt>
-			<code>lombok.fieldNameConstants.suffix</code> = <em>a string</em> (default: '' - the blank string)
+			<code>lombok.fieldNameConstants.innerTypeName</code> = <em>a string</em> (default: 'Fields')
 		</dt><dd>
-			Lombok will generate the name for each fieldconstant by constant-casing the field name and then suffixing this string to the result.
+			The name of the inner type generated by lombok can be controlled with this configuration key.
 		</dd>
 	</@f.confKeys>
 
 	<@f.smallPrint>
 		<p>
-			Like other lombok handlers that touch fields, any field whose name starts with a dollar (<code>$</code>) symbol is skipped entirely. Such a field will not be modified at all. Static fields are also skipped.
+			From lombok v1.16.22 to lombok v1.18.2, this feature generated constants inside the type directly; the name of these fields would for example turn field <code>exampleFieldName</code> into <code>public static final String FIELD_EXAMPLE_FIELD_NAME = "exampleFieldName";</code>. The prefix and suffix (here, <code>FIELD_</code>, and the empty string) were configurable. Starting with lombok v1.18.4 this feature has been redesigned into generating an inner type as described above.
+		</p><p>
+			Any parameters of lombok annotations that take strings need to be supplied actual string literals; you cannot have references to constants like those generated by <code>@FieldNameConstants</code>. If you'd like to use <code>@FieldNameConstants</code> to for example fill in the <code>of</code> and/or <code>exclude</code> parameters of <code>@ToString</code> and similar lombok annotations, use the <code>@ToString.Include</code> / <code>@ToString.Exclude</code> etc system instead; these are described at the feature pages for those features.
 		</p><p>
-			The annotation can itself be used to set prefix/suffix. If you do so, it overrides the <code>lombok.fieldNameConstants.prefix/suffix</code> config key. Example: <code>@FieldNameConstants(prefix = "")</code>: This would generate for field <code>helloWorld</code> a constant named <code>HELLO_WORLD</code> instead of the default <code>FIELD_HELLO_WORLD</code>.
+			Like other lombok handlers that touch fields, any field whose name starts with a dollar (<code>$</code>) symbol is skipped entirely. Such a field will not be modified at all. Static fields are also skipped.
 		</p>
 	</@f.smallPrint>
 </@f.scaffold>