diff options
Diffstat (limited to 'website/templates/features')
| -rw-r--r-- | website/templates/features/With.html | 7 | ||||
| -rw-r--r-- | website/templates/features/experimental/index.html | 7 | ||||
| -rw-r--r-- | website/templates/features/index.html | 4 |
3 files changed, 10 insertions, 8 deletions
diff --git a/website/templates/features/With.html b/website/templates/features/With.html index 35c52dab..f1719e19 100644 --- a/website/templates/features/With.html +++ b/website/templates/features/With.html @@ -14,13 +14,14 @@ </p><p> For example, if you create <code>public class Point { private final int x, y; }</code>, setters make no sense because the fields are final. <code>@With</code> can generate a <code>withX(int newXValue)</code> method for you which will return a new point with the supplied value for <code>x</code> and the same value for <code>y</code>. </p><p> + The <code>@With</code> relies on a constructor for all fields in order to do its work. If this constructor does not exist, your <code>@With</code> annotation will result in a compile time error message. Lombok's own <a href="/features/constructor"><code>@AllArgsConstructor</code></a>. As <a href="/features/Value"><code>Value</code></a> will automatically produce an all args constructor as well, you can use that too. It's of course also acceptable if you manually write this constructor. It must contain all non-static fields, in the same lexical order. + </p><p> Like <a href="/features/GetterSetter"><code>@Setter</code></a>, you can specify an access level in case you want the generated with method to be something other than <code>public</code>:<br /> <code>@With(level = AccessLevel.PROTECTED)</code>. Also like <a href="/features/GetterSetter"><code>@Setter</code></a>, you can also put a <code>@With</code> annotation on a type, which means a <code>with</code> method is generated for each field (even non-final fields). </p><p> To put annotations on the generated method, you can use <code>onMethod=@__({@AnnotationsHere})</code>. Be careful though! This is an experimental feature. For more details see the documentation on the <a href="/features/experimental/onX">onX</a> feature. </p><p> javadoc on the field will be copied to generated with methods. Normally, all text is copied, and <code>@param</code> is <em>moved</em> to the with method, whilst <code>@return</code> lines are stripped from the with method's javadoc. Moved means: Deleted from the field's javadoc. It is also possible to define unique text for the with method's javadoc. To do that, you create a 'section' named <code>WITH</code>. A section is a line in your javadoc containing 2 or more dashes, then the text 'WITH', followed by 2 or more dashes, and nothing else on the line. If you use sections, <code>@return</code> and <code>@param</code> stripping / copying for that section is no longer done (move the <code>@param</code> line into the section). - </p><p> - If you have a hierarchical immutable data structure, the <a href="/features/experimental/WithBy"><code>@WithBy</code></a> feature might be more suitable than <code>@With</code> + </p> </@f.overview> <@f.snippets name="With" /> @@ -45,8 +46,6 @@ </p><p> No method is generated if any method already exists with the same name (case insensitive) and same parameter count. For example, <code>withX(int x)</code> will not be generated if there's already a method <code>withX(String... x)</code> even though it is technically possible to make the method. This caveat exists to prevent confusion. If the generation of a method is skipped for this reason, a warning is emitted instead. Varargs count as 0 to N parameters. </p><p> - For <code>boolean</code> fields that start with <code>is</code> immediately followed by a title-case letter, nothing is prefixed to generate the wither name. - </p><p> Various well known annotations about nullity cause null checks to be inserted and will be copied to the parameter. See <a href="/features/GetterSetter">Getter/Setter</a> documentation's small print for more information. </p> </@f.smallPrint> diff --git a/website/templates/features/experimental/index.html b/website/templates/features/experimental/index.html index 112d30c4..960f4b1a 100644 --- a/website/templates/features/experimental/index.html +++ b/website/templates/features/experimental/index.html @@ -48,10 +48,6 @@ Don't lose your composition. </@main.feature> - <@main.feature title="@Wither" href="Wither"> - Immutable 'setters' - methods that create a clone but with one changed field. - </@main.feature> - <@main.feature title="onMethod= / onConstructor= / onParam=" href="onX"> Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating. </@main.feature> @@ -90,6 +86,9 @@ <@main.feature title="@Builder: promoted" href="/features/Builder"> <code>@Builder</code> is a solid base to build APIs on, and has been moved to the main package. </@main.feature> + <@main.feature title="@Wither: renamed to @With, and promoted" href="/features/With"> + Immutable 'setters' - methods that create a clone but with one changed field. + </@main.feature> </div> </div> </div> diff --git a/website/templates/features/index.html b/website/templates/features/index.html index 06b47c0b..9e2f53e8 100644 --- a/website/templates/features/index.html +++ b/website/templates/features/index.html @@ -66,6 +66,10 @@ <code>synchronized</code> done right: Don't expose your locks. </@main.feature> + <@main.feature title="@With" href="With"> + Immutable 'setters' - methods that create a clone but with one changed field. + </@main.feature> + <@main.feature title="@Getter(lazy=true)" href="GetterLazy"> Laziness is a virtue! </@main.feature> |