aboutsummaryrefslogtreecommitdiff
path: root/website/templates/features/experimental/StandardException.html
diff options
context:
space:
mode:
authorttzn <ttzn.dev@gmail.com>2021-03-24 23:52:08 +0100
committerttzn <ttzn.dev@gmail.com>2021-03-24 23:52:08 +0100
commitaf16ba23cd46fa3d3b096daa8d725df2b4d78976 (patch)
tree70639ee886b36a8cc1840ecb34c7d839548b46ee /website/templates/features/experimental/StandardException.html
parent63ea3db6b7ab41ff945cad1ec8af7f78b5679f66 (diff)
downloadlombok-af16ba23cd46fa3d3b096daa8d725df2b4d78976.tar.gz
lombok-af16ba23cd46fa3d3b096daa8d725df2b4d78976.tar.bz2
lombok-af16ba23cd46fa3d3b096daa8d725df2b4d78976.zip
@StandardException feature working draft
* move feature under experimental * replace ProviderFor with Provides * add doc material (to be completed) * add author
Diffstat (limited to 'website/templates/features/experimental/StandardException.html')
-rw-r--r--website/templates/features/experimental/StandardException.html36
1 files changed, 36 insertions, 0 deletions
diff --git a/website/templates/features/experimental/StandardException.html b/website/templates/features/experimental/StandardException.html
new file mode 100644
index 00000000..25324c4b
--- /dev/null
+++ b/website/templates/features/experimental/StandardException.html
@@ -0,0 +1,36 @@
+<#import "../_features.html" as f>
+
+<@f.scaffold title="@StandardException"
+ logline="TODO">
+ <@f.history>
+ <p>
+ <code>@StandardException</code> was introduced as an experimental feature in lombok v1.18.21.
+ </p>
+ </@f.history>
+
+ <@f.overview>
+ <p>
+ This annotation is intended to be used on subclasses of <code>java.util.Throwable</code>. For each of the four constructors in <code>Throwable</code>, it will generate a corresponding constructor in the target class, that simply forwards its argument to its super-counterpart.
+ </p><p>
+ If any of those constructors is manually overriden, it is simply skipped. This allows applying special treatment such as annotations.
+ </p>
+ </@f.overview>
+
+ <@f.snippets name="StandardException" />
+
+ <@f.confKeys>
+ <dt>
+ <code>lombok.standardException.addConstructorProperties</code> = [<code>true</code> | <code>false</code>] (default: <code>false</code>)
+ </dt><dt>
+ <code>lombok.standardException.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
+ </dt><dd>
+ Lombok will flag any usage of <code>@StandardException</code> as a warning or error if configured.
+ </dd>
+ </@f.confKeys>
+
+ <@f.smallPrint>
+ <p>
+ Although such situation is unlikely to occur, this annotation can technically be applied to any class for which all four expected constructors are defined in a superclass.
+ </p>
+ </@f.smallPrint>
+</@f.scaffold>