aboutsummaryrefslogtreecommitdiff
path: root/website/templates/features/experimental/StandardException.html
blob: 25324c4bb7399a99a3217ddf2c1570feb116a772 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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>