tiennm99/lombok
1
0 Fork 0
mirror of https://github.com/tiennm99/lombok.git synced 2026-10-11 12:19:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

[With] updated documentation for Wither/With

Browse Source
This commit is contained in:
Reinier Zwitserloot committed 2019-08-27 00:15:47 +02:00
1 parent 461b5541da
commit da5d9a12e7
8 files changed
+90 -101
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/changelog.markdown
+1
View File
@@ -2,6 +2,7 @@ Lombok Changelog
----------------
### v1.18.9 "Edgy Guinea Pig"
* PROMOTION: `@Wither` has been promoted to the main package, renamed to `@With`. Otherwise, no changes have been made to the annotation. The old experimenetal annotation will remain for a few versions as a deprecated annotation. If you had `lombok.config` configuration for this annotation, the configuration keys for this feature have been renamed.
* FEATURE: You can now configure a custom logger framework using the new `@CustomLog` annotation in combination with the `lombok.log.custom.declaration` configuration key. See the [log documentation](https://projectlombok.org/features/Log) for more information. [Pullrequest #2086](https://github.com/rzwitserloot/lombok/pull/2086) with thanks to Adam Juraszek.
* ENHANCEMENT: Thanks to Mark Haynes, the `staticConstructor` will now also be generated if a (private) constructor already exists. [Issue #2100](https://github.com/rzwitserloot/lombok/issues/2100)
* ENHANCEMENT: `val` is now capable of decoding the type of convoluted expressions (particularly if the right hand side involves lambdas and conditional (ternary) expressions). [Pull Request #2109](https://github.com/rzwitserloot/lombok/pull/2109) and [Pull Request #2138](https://github.com/rzwitserloot/lombok/pull/2138) with thanks to Alexander Bulgakov.
website/extra/htaccess
+1
View File
@@ -59,6 +59,7 @@ RewriteRule ^features/${pg?no_esc}(\.html)?/?$ /features/${pg?no_esc} [NC,R=301]
RewriteRule ^features/experimental/Builder(\.html)?/?$ /features/Builder [NC,R=301]
RewriteRule ^features/experimental/Value(\.html)?/?$ /features/Value [NC,R=301]
RewriteRule ^features/experimental/var(\.html)?/?$ /features/var [NC,R=301]
RewriteRule ^features/experimental/Wither(\.html)?/?$ /features/With [NC,R=301]
RewriteRule ^features/experimental/all$ /features/experimental/index.html [L,END]
RewriteRule ^features/experimental(/all)?/?$ /features/experimental/all [NC,R=301]
website/templates/features/With.html
+53
View File
@@ -0,0 +1,53 @@
<#import "_features.html" as f>
<@f.scaffold title="@With" logline="Immutable 'setters' - methods that create a clone but with one changed field.">
<@f.history>
<p>
<code>@Wither</code> was introduced as experimental feature in lombok v0.11.4.
</p><p>
<code>@Wither</code> was renamed to <code>@With</code>, and moved out of experimental and into the core package, in lombok v1.18.10.
</@f.history>
<@f.overview>
<p>
The next best alternative to a setter for an immutable property is to construct a clone of the object, but with a new value for this one field. A method to generate this clone is precisely what <code>@With</code> generates: a <code>withFieldName(newValue)</code> method which produces a clone except for the new value for the associated field.
</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>
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>
</@f.overview>
<@f.snippets name="With" />
<@f.confKeys>
<dt>
<code>lombok.with.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
</dt><dd>
Lombok will flag any usage of <code>@With</code> as a warning or error if configured.
</dd>
</@f.confKeys>
<@f.smallPrint>
<p>
With methods cannot be generated for static fields because that makes no sense.
</p><p>
With methods can be generated for abstract classes, but this generates an abstract method with the appropriate signature.
</p><p>
When applying <code>@With</code> to a type, static fields and fields whose name start with a $ are skipped.
</p><p>
For generating the method names, the first character of the field, if it is a lowercase character, is title-cased, otherwise, it is left unmodified. Then, <code>with</code> is prefixed.
</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>
</@f.scaffold>
website/templates/features/experimental/Wither.html
-66
View File
@@ -1,66 +0,0 @@
<#import "../_features.html" as f>
<@f.scaffold title="@Wither" logline="Immutable 'setters' - methods that create a clone but with one changed field.">
<@f.history>
<p>
@Wither was introduced as experimental feature in lombok v0.11.4.
</p>
</@f.history>
<@f.experimental>
<ul>
<li>
Still not sure that <code>@Wither</code> is an appropriate name for this feature.
</li><li>
Should there be an option to supply a way of cloning the input somehow?
</li><li>
Should the way that the clone is created by configurable?
</li><li>
Should we replace @Wither entirely with a builder class?
</li>
</ul>
Current status: <em>neutral</em> - More feedback requires on the items in the above list before promotion to the main package is warranted.
</@f.experimental>
<@f.overview>
<p>
The next best alternative to a setter for an immutable property is to construct a clone of the object, but with a new value for this one field. A method to generate this clone is precisely what <code>@Wither</code> generates: a <code>withFieldName(newValue)</code> method which produces a clone except for the new value for the associated field.
</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>@Wither</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>
Like <a href="/features/GetterSetter"><code>@Setter</code></a>, you can specify an access level in case you want the generated wither to be something other than <code>public</code>:<br /> <code>@Wither(level = AccessLevel.PROTECTED)</code>. Also like <a href="/features/GetterSetter"><code>@Setter</code></a>, you can also put a <code>@Wither</code> annotation on a type, which means a 'wither' 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>; to put annotations on the only parameter of a generated wither method, you can use <code>onParam=@__({@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>
<em>NEW in lombok v1.12.0:</em> javadoc on the field will now be copied to generated withers. Normally, all text is copied, and <code>@param</code> is <em>moved</em> to the wither, whilst <code>@return</code> lines are stripped from the wither's javadoc. Moved means: Deleted from the field's javadoc. It is also possible to define unique text for the wither's javadoc. To do that, you create a 'section' named <code>WITHER</code>. A section is a line in your javadoc containing 2 or more dashes, then the text 'WITHER', 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>
</@f.overview>
<@f.snippets name="experimental/Wither" />
<@f.confKeys>
<dt>
<code>lombok.wither.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
</dt><dd>
Lombok will flag any usage of <code>@Wither</code> as a warning or error if configured.
</dd>
</@f.confKeys>
<@f.smallPrint>
<p>
Withers cannot be generated for static fields because that makes no sense.
</p><p>
Withers can be generated for abstract classes, but this generates an abstract method with the appropriate signature.
</p><p>
When applying <code>@Wither</code> to a type, static fields and fields whose name start with a $ are skipped.
</p><p>
For generating the method names, the first character of the field, if it is a lowercase character, is title-cased, otherwise, it is left unmodified. Then, <code>with</code> is prefixed.
</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>
</@f.scaffold>
website/usageExamples/WithExample_post.jpage
+21
View File
@@ -0,0 +1,21 @@
import lombok.NonNull;
public class WithExample {
private final int age;
private @NonNull final String name;
public WithExample(String name, int age) {
if (name == null) throw new NullPointerException();
this.name = name;
this.age = age;
}
public WithExample withAge(int age) {
return this.age == age ? this : new WithExample(name, age);
}
protected WithExample withName(@NonNull String name) {
if (name == null) throw new java.lang.NullPointerException("name");
return this.name == name ? this : new WithExample(name, age);
}
}
website/usageExamples/WithExample_pre.jpage
+14
View File
@@ -0,0 +1,14 @@
import lombok.AccessLevel;
import lombok.NonNull;
import lombok.With;
public class WithExample {
@With private final int age;
@With(AccessLevel.PROTECTED) @NonNull private final String name;
public WithExample(String name, int age) {
if (name == null) throw new NullPointerException();
this.name = name;
this.age = age;
}
}
website/usageExamples/experimental/WitherExample_post.jpage
-21
View File
@@ -1,21 +0,0 @@
import lombok.NonNull;
public class WitherExample {
private final int age;
private @NonNull final String name;
public WitherExample(String name, int age) {
if (name == null) throw new NullPointerException();
this.name = name;
this.age = age;
}
public WitherExample withAge(int age) {
return this.age == age ? this : new WitherExample(name, age);
}
protected WitherExample withName(@NonNull String name) {
if (name == null) throw new java.lang.NullPointerException("name");
return this.name == name ? this : new WitherExample(name, age);
}
}
website/usageExamples/experimental/WitherExample_pre.jpage
-14
View File
@@ -1,14 +0,0 @@
import lombok.AccessLevel;
import lombok.NonNull;
import lombok.experimental.Wither;
public class WitherExample {
@Wither private final int age;
@Wither(AccessLevel.PROTECTED) @NonNull private final String name;
public WitherExample(String name, int age) {
if (name == null) throw new NullPointerException();
this.name = name;
this.age = age;
}
}