diff options
| author | Reinier Zwitserloot <reinier@zwitserloot.com> | 2021-10-26 15:47:57 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-26 15:47:57 +0200 |
| commit | 370950fd77021d048e0c3bced2ce9655d13b508b (patch) | |
| tree | 14616d417afc03ac8e04a13ac6c0342211d5576b /website | |
| parent | 3a0176fd907ec594194cabf843a5681fd7b811fd (diff) | |
| parent | 746ce5d4eece628b1d66a4c60b3bae422f8d0034 (diff) | |
| download | lombok-370950fd77021d048e0c3bced2ce9655d13b508b.tar.gz lombok-370950fd77021d048e0c3bced2ce9655d13b508b.tar.bz2 lombok-370950fd77021d048e0c3bced2ce9655d13b508b.zip | |
Merge pull request #3012 from Fatima-Rami/documentation-for-fieldnameconstants
Documentation for fieldnameconstants
Diffstat (limited to 'website')
| -rw-r--r-- | website/templates/features/experimental/FieldNameConstants.html | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/website/templates/features/experimental/FieldNameConstants.html b/website/templates/features/experimental/FieldNameConstants.html index e88b7670..06fa23b5 100644 --- a/website/templates/features/experimental/FieldNameConstants.html +++ b/website/templates/features/experimental/FieldNameConstants.html @@ -24,7 +24,7 @@ <p> 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 - write <code>@FieldNameConstants(asEnum = true)</code> for the enum variant. <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, unless you set the <code>lombok.fieldNameConstants.uppercase = true</code> option in your <code>lombok.config</code> file; in that case lombok will try to <code>UPPER_CASE</code> the name. </p><p> - 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>. + 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", level = 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> 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> |