Skip to content

Commit

Permalink
[website] Clarified @accessors documentation and added links to issue #…
Browse files Browse the repository at this point in the history
…2464 and issue #2693
  • Loading branch information
rzwitserloot committed Jan 3, 2021
1 parent 6f218d5 commit 831e277
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions website/templates/features/experimental/Accessors.html
Expand Up @@ -15,7 +15,12 @@
New feature – community feedback requested.
</li>
</ul>
Current status: <em>positive</em> - Currently we feel this feature may move out of experimental status with no or minor changes soon.
Current status: <em>neutral</em> - Some changes are expected. These changes are intended to be backwards compatible, but should start in an experimental feature:
<ul>
<li>Open feature request: naming behaviour for properties that start with a lowercase letter followed by an uppercase letter. Half of specs, tools and lombok users prefer that a field named <code>uLimit</code> into <code>getULimit</code> (including lombok) and the other half turn prefer <code>getuLimit</code>. <code>@Accessors</code> may be involved in any update that addresses this <a href="https://github.com/rzwitserloot/lombok/issues/2693">request</a>.</li>
<li>Open feature request: More control over naming accessors; for example to address creatively named boolean properties: Turn <code>boolean wasRunning</code> into <code>boolean wasRunning()</code> instead of <code>boolean isWasRunning()</code>, as well as more expansive prefix support. <code>@Accessors</code> will be involved if this feature <a href="https://github.com/rzwitserloot/lombok/issues/2464">request</a> is addressed.</li>
<li><code>@Accessors</code> currently does not 'cascade' from field <code>@Accessors</code> annotation to the class-level <code>@Accessors</code> annotation, but it does 'cascade' to <code>lombok.config</code>. Changing this is not difficult but backwards incompatible. It's not likely to break much existing code, but this needs to be decided on before the feature can move out of <em>experimental</em> status.</li>
</ul>
</@f.experimental>

<@f.overview>
Expand All @@ -39,7 +44,7 @@
</li>
</ul>
<p><p>
The <code>@Accessors</code> annotation is legal on types and fields; the annotation that applies is the one on the field if present, otherwise the one on the class. When a <code>@Accessors</code> annotation on a field is present, any <code>@Accessors</code> annotation also present on that field's type is ignored.
The <code>@Accessors</code> annotation is legal on types and fields; the annotation that applies is the one on the field if present, otherwise the one on the class. When a <code>@Accessors</code> annotation on a field is present, any <code>@Accessors</code> annotation also present on the class the field is in, is entirely ignored, <em>even for properties not configured on the field <code>@Accessors</code></em>. This in contrast to any <code>lombok.config</code> configuration keys which serve as fall-back default if any explicit <code>@Accessors</code> annotation doesn't specify.
</p>
</@f.overview>

Expand Down

0 comments on commit 831e277

Please sign in to comment.