Merge pull request #2251 from nejads/master

Add documentation for Tolerate
This commit is contained in:
Reinier Zwitserloot authored and GitHub committed 2019-12-11 13:01:32 +01:00
commit d126ad64b3
4 files changed
+58 -1

No files matched your search

@@ -0,0 +1,34 @@
<#import "../_features.html" as f>
<@f.scaffold title="@Tolerate" logline="Skip, jump, and forget! Skip a method or constructor.">
<@f.history>
<p>
<code>@Tolerate</code> was introduced as feature in lombok v1.14.2<br />
</p>
</@f.history>
<@f.experimental>
<ul>
<li>
Not used that much.
</li>
<li>
Difficult to support for edge cases, such as recursive delegation.
</li>
</ul>
</@f.experimental>
<@f.overview>
<p>
Any method or constructor can be annotated with <code>@Tolerate</code> and lombok will skip it when
considering whether or not to generate a method or constructor. This is useful if the types of the
parameters of your method do not clash with what lombok would generate.
</p>
<p>
Put on any method or constructor to make lombok pretend it doesn't exist,i.e., to generate a method
which would otherwise be skipped due to possible conflicts.
</p>
</@f.overview>
<@f.snippets name="experimental/Tolerate" />
</@f.scaffold>
@@ -9,7 +9,7 @@
</div>
<div class="row">
The <a href="/api/">Lombok javadoc</a> is available, but we advise these pages.
<p>
Experimental features are available in your normal lombok installation, but are not as robustly supported as lombok's main features. In particular, experimental features:
<ul>
@@ -67,6 +67,10 @@
<@main.feature title="@SuperBuilder" href="SuperBuilder">
Bob now knows his ancestors: Builders with fields from superclasses, too.
</@main.feature>
<@main.feature title="@Tolerate" href="Tolerate">
Skip, jump, and forget! Skip a method or constructor.
</@main.feature>
</div>
<@f.confKeys>
@@ -0,0 +1,8 @@
public class TolerateExample {
@Setter
private Date date;
public void setDateFromString(String date) {
this.date = Date.valueOf(date);
}
}
@@ -0,0 +1,11 @@
import lombok.experimental.Tolerate;
public class TolerateExample {
@Setter
private Date date;
@Tolerate
public void setDate(String date) {
this.date = Date.valueOf(date);
}
}