diff options
Diffstat (limited to 'website/features')
23 files changed, 285 insertions, 2 deletions
diff --git a/website/features/Cleanup.html b/website/features/Cleanup.html index b5adff3a..f4b16946 100644 --- a/website/features/Cleanup.html +++ b/website/features/Cleanup.html @@ -40,6 +40,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.cleanup.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Cleanup</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/Constructor.html b/website/features/Constructor.html index c7e40dfb..a3163bfa 100644 --- a/website/features/Constructor.html +++ b/website/features/Constructor.html @@ -60,6 +60,17 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.anyConstructor.suppressConstructorProperties</code> = [<code>true</code> | <code>false</code>] (default: <code>false</code>)</dt> + <dd>If set to <code>true</code>, then lombok will skip adding a <code>@java.beans.ConstructorProperties</code> to generated constructors. This is useful in android and GWT development where that annotation is not usually available.</dd> + <dt><code>lombok.</code>[<code>allArgsConstructor</code>|<code>requiredArgsConstructor</code>|<code>noArgsConstructor</code>]<code>.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of the relevant annotation (<code>@AllArgsConstructor</code>, <code>@RequiredArgsConstructor</code> or <code>@NoArgsConstructor</code>) as a warning or error if configured.</dd> + <dt><code>lombok.anyConstructor.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of any of the 3 constructor-generating annotations as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> @@ -77,6 +88,8 @@ While <code>suppressConstructorProperties</code> has been marked deprecated in anticipation of a world where all java environments have the <code>@ConstructorProperties</code> annotation available, first GWT 2.2 and Android 2.3.3, which do not (yet) have this annotation, will have to be ancient history before this annotation parameter will be removed. + </p><p> + The <code>flagUsage</code> configuration keys do not trigger when a constructor is generated by <code>@Data</code>, <code>@Value</code> or any other lombok annotation. </p> </div> </div> diff --git a/website/features/Data.html b/website/features/Data.html index 8f11ca1c..3ae03df1 100644 --- a/website/features/Data.html +++ b/website/features/Data.html @@ -59,6 +59,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.data.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Data</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p>See the small print of <a href="ToString.html"><code>@ToString</code></a>, <a href="EqualsAndHashCode.html"><code>@EqualsAndHashCode</code></a>, diff --git a/website/features/EqualsAndHashCode.html b/website/features/EqualsAndHashCode.html index f3fb8488..89d71502 100644 --- a/website/features/EqualsAndHashCode.html +++ b/website/features/EqualsAndHashCode.html @@ -54,6 +54,15 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.equalsAndHashCode.doNotUseGetters</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, lombok will access fields directly instead of using getters (if available) when generating <code>equals</code> and <code>hashCode</code> methods. The annotation parameter '<code>doNotUseGetters</code>', if explicitly specified, takes precedence over this setting.</dd> + <dt><code>lombok.equalsAndHashCode.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@EqualsAndHashCode</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/GetterLazy.html b/website/features/GetterLazy.html index 3a711f58..a438f08a 100644 --- a/website/features/GetterLazy.html +++ b/website/features/GetterLazy.html @@ -30,6 +30,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys (in addition to those listed on <a href="GetterSetter.html"><code>@Getter</code>'s main page</a>):</h3> + <dl> + <dt><code>lombok.getter.lazy.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Getter(lazy=true)</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/GetterSetter.html b/website/features/GetterSetter.html index 76b61d80..a0da405d 100644 --- a/website/features/GetterSetter.html +++ b/website/features/GetterSetter.html @@ -46,6 +46,21 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.accessors.chain</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, generated setters will return <code>this</code> (instead of <code>void</code>). An explicitly configured <code>chain</code> parameter of an <a href="experimental/Accessors.html"><code>@Accessors</code></a> annotation takes precedence over this setting.</dd> + <dt><code>lombok.accessors.fluent</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, generated getters and setters will not be prefixed with the bean-standard '<code>get</code>, <code>is</code> or <code>set</code>; instead, the methods will use the same name as the field (minus prefixes). An explicitly configured <code>chain</code> parameter of an <a href="experimental/Accessors.html"><code>@Accessors</code></a> annotation takes precedence over this setting.</dd> + <dt><code>lombok.accessors.prefix</code> += <em>a field prefix</em> (default: empty list)</dt> + <dd>This is a list property; entries can be added with the <code>+=</code> operator. Inherited prefixes from parent config files can be removed with the <code>-=</code> operator. Lombok will strip any matching field prefix from the name of a field in order to determine the name of the getter/setter to generate. For example, if <code>m</code> is one of the prefixes listed in this setting, then a field named <code>mFoobar</code> will result in a getter named <code>getFoobar()</code>, not <code>getMFoobar()</code>. An explicitly configured <code>prefix</code> parameter of an <a href="experimental/Accessors.html"><code>@Accessors</code></a> annotation takes precedence over this setting.</dd> + <dt><code>lombok.setter.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Setter</code> as a warning or error if configured.</dd> + <dt><code>lombok.getter.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Getter</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/Log.html b/website/features/Log.html index c459e7ff..8b635280 100644 --- a/website/features/Log.html +++ b/website/features/Log.html @@ -49,6 +49,29 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.log.fieldName</code> = <em>an identifier</em> (default: <code>log</code>)</dt> + <dd>The generated logger fieldname is by default '<code>log</code>', but you can change it to a different name with this setting.</dd> + <dt><code>lombok.log.fieldIsStatic</code> = [<code>true</code> | <code>false</code>] (default: true)</dt> + <dd>Normally the generated logger is a <code>static</code> field. By setting this key to <code>false</code>, the generated field will be an instance field instead.</dd> + <dt><code>lombok.log.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of any of the various log annotations as a warning or error if configured.</dd> + <dt><code>lombok.log.apacheCommons.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.apachecommons.CommonsLog</code> as a warning or error if configured.</dd> + <dt><code>lombok.log.javaUtilLogging.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.java.Log</code> as a warning or error if configured.</dd> + <dt><code>lombok.log.log4j.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.log4j.Log4j</code> as a warning or error if configured.</dd> + <dt><code>lombok.log.log4j2.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.log4j.Log4j2</code> as a warning or error if configured.</dd> + <dt><code>lombok.log.slf4j.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.slf4j.Slf4j</code> as a warning or error if configured.</dd> + <dt><code>lombok.log.xslf4j.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@lombok.extern.slf4j.XSlf4j</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> @@ -59,7 +82,7 @@ </div> </div> <div class="footer"> - <a href="index.html">Back to features</a> | <a href="GetterLazy.html">Previous feature (@Getter(lazy=true))</a> | <span class="disabled">Next feature</span><br /> + <a href="index.html">Back to features</a> | <a href="GetterLazy.html">Previous feature (@Getter(lazy=true))</a> | <a href="configuration.html">Next feature (configuration)</a><br /> <a href="../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright © 2009-2014 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span> </div> <div style="clear: both;"></div> diff --git a/website/features/NonNull.html b/website/features/NonNull.html index 9faad502..0e7d064d 100644 --- a/website/features/NonNull.html +++ b/website/features/NonNull.html @@ -39,6 +39,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.nonNull.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@NonNull</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/SneakyThrows.html b/website/features/SneakyThrows.html index 875ee65c..e1cd6685 100644 --- a/website/features/SneakyThrows.html +++ b/website/features/SneakyThrows.html @@ -51,6 +51,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.sneakyThrows.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@SneakyThrows</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/Synchronized.html b/website/features/Synchronized.html index c7e92aae..85c161c3 100644 --- a/website/features/Synchronized.html +++ b/website/features/Synchronized.html @@ -41,6 +41,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.synchronized.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Synchronized</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/ToString.html b/website/features/ToString.html index ffda89d1..6cdd8453 100644 --- a/website/features/ToString.html +++ b/website/features/ToString.html @@ -41,6 +41,17 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.toString.includeFieldNames</code> = [<code>true</code> | <code>false</code>] (default: true)</dt> + <dd>Normally lombok generates a fragment of the toString response for each field in the form of <code>fieldName = fieldValue</code>. If this setting is set to <code>false</code>, lombok will omit the name of the field and simply deploy a comma-separated list of all the field values. The annotation parameter '<code>includeFieldNames</code>', if explicitly specified, takes precedence over this setting.</dd> + <dt><code>lombok.toString.doNotUseGetters</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, lombok will access fields directly instead of using getters (if available) when generating <code>toString</code> methods. The annotation parameter '<code>doNotUseGetters</code>', if explicitly specified, takes precedence over this setting.</dd> + <dt><code>lombok.toString.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@ToString</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/Value.html b/website/features/Value.html index 07e1e949..09557c6a 100644 --- a/website/features/Value.html +++ b/website/features/Value.html @@ -45,6 +45,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.value.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Value</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/configuration.html b/website/features/configuration.html new file mode 100644 index 00000000..acf874e7 --- /dev/null +++ b/website/features/configuration.html @@ -0,0 +1,91 @@ +<!DOCTYPE html> +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <link rel="stylesheet" type="text/css" href="../logi/reset.css" /> + <link rel="stylesheet" type="text/css" href="features.css" /> + <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon" /> + <meta name="description" content="Spice up your java" /> + <title>Configuration system</title> +</head><body><div id="pepper"> + <div class="minimumHeight"></div> + <div class="meat"> + <div class="header"><a href="../index.html">Project Lombok</a></div> + <h1>Configuration system</h1> + <div class="byline">Lombok, made to order: Configure lombok features in one place for your entire project or even your workspace.</div> + <div class="overview"> + <h3>Overview</h3> + <p> + <em>NEW in lombok 1.14: </em>You can create <code>lombok.config</code> files in any directory and put configuration directives in it. These apply to all source files in this directory and all child directories.<br /> + The configuration system is particularly useful for configurable aspects of lombok which tend to be the same across an entire project, such as the name of your log variable. The configuration system can also be used to tell lombok to flag any usage of some lombok feature you don't like as a warning or even an error. + </p><p> + Usually, a user of lombok puts a <code>lombok.config</code> file with their preferences in a workspace or project root directory, with the special <code>config.stopBubbling = true</code> key to tell lombok this is your root directory. You can then create <code>lombok.config</code> files in any subdirectories (generally representing projects or source packages) with different settings. + </p><p> + An up to date list of all configuration keys supported by your version of lombok can be generated by running: + <div class="snippet example"><code>java -jar lombok.jar config -g --verbose</code></div> + The output of the <em>config</em> tool is itself a valid <code>lombok.config</code> file.<br /> + The <em>config</em> tool can also be used to display the complete lombok configuration used for any given directory or source file by supplying these as arguments. + </p><p> + A sample of available configuration options (see the feature pages of the lombok features for their related config keys, as well as <code>java -jar lombok.jar config -g</code> for the complete list): + <dl> + <dt><code>lombok.accessors.chain</code></dt> + <dd>If set to <code>true</code>, generated setters will 'chain' by default (They will return <code>this</code> instead of having a <code>void</code> return type).</dd> + <dt><code>lombok.accessors.fluent</code></dt> + <dd>If set to <code>true</code>, generated setters and getters will simply be named the same as the field name, without a <code>get</code> or <code>set</code> prefix.</dd> + <dt><code>lombok.anyConstructor.suppressConstructorProperties</code></dt> + <dd>If <code>true</code>, lombok will not generate a <code>@java.beans.ConstructorProperties</code> annotation when generating constructors. This is particularly useful for GWT and Android development.</dd> + <dt><code>lombok.log.fieldName</code></dt> + <dd>The name of the generated log field (default: <code>log</code>).</dd> + <dt><code>lombok.<em>(featureName)</em>.flagUsage</code></dt> + <dd>Allows you to forcibly stop or discourage use of a lombok feature. Legal values for this key are <code>warning</code> or <code>error</code>. Some examples of values for <em>(featureName)</em> are: "<code>experimental</code>" (flags use of any of the <a href="experimental/index.html">experimental</a> features)</li>, "<a href="experimental/Builder.html"><code>builder</code></a>", "<a href="SneakyThrows.html"><code>sneakyThrows</code></a>", or "<a href="experimental/ExtensionMethod.html"><code>extensionMethod</code></a>".</dd> + </dl> + </p><p> + Configuration files are hierarchical: Any configuration setting applies to all source files in that directory, and all source files in subdirectories, but configuration settings closer to the source file take precedence. For example, if you have in <code>/Users/me/projects/lombok.config</code> the following: + <div class="snippet example"> + <code>lombok.log.fieldName = foobar</code> + </div></div> + and in <code>/Users/me/projects/MyProject/lombok.config</code> you have: + <div class="snippet example"> + <code>lombok.log.fieldName = xyzzy</code> + </div> + + Then the various <a href="Log.html"><code>@Log</code></a> annotations will use <code>foobar</code> instead of the default <code>log</code> as a field name to generate in all your projects, + except for your project in <code>/Users/me/projects/MyProject</code>, where <code>xyzzy</code> is used instead. + </p><p> + To restore a configuration key set by a parent config file back to the default, the <code>clear</code> option can be used. For example, if a parent configuration file has configured all use of <code>val</code> to emit a warning, you can turn off the warnings for a subdirectory by including in it a <code>lombok.config</code> file with: + <div class="snippet example"> + <code>clear lombok.val.flagUsage</code> + </div> + </p><p> + Some configuration keys take lists. For lists, use <code>+=</code> to add an entry. You can remove a single item from the list (useful to undo a parent configuration file's setting) with <code>-=</code>. For example: + <div class="snippet example"> + <code>lombok.accessors.prefix += m_</code> + </div> + </p><p> + To stop lombok from looking at parent directories for more configuration files, the special key: + <div class="snippet example"> + <code>config.stopBubbling = true</code> + </div> + can be included. + </p><p> + Comments can be included in <code>lombok.config</code> files; any line that starts with <code>#</code> is considered a comment. + </p> + </div> + <div style="clear: left;"></div> + <div class="footer"> + <a href="index.html">Back to features</a> | <a href="Log.html">Previous feature (@Log)</a> | <span class="disabled">Next feature</span><br /> + <a href="../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright © 2009-2014 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span> + </div> + <div style="clear: both;"></div> + </div> +</div> +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> + try { + var pageTracker = _gat._getTracker("UA-9884254-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> +</body></html> diff --git a/website/features/experimental/Accessors.html b/website/features/experimental/Accessors.html index 79c3d272..20590a07 100644 --- a/website/features/experimental/Accessors.html +++ b/website/features/experimental/Accessors.html @@ -72,6 +72,19 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.accessors.chain</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>chain</code> parameter, will act as if <code>@Accessors(chain = true)</code> is present.</dd> + <dt><code>lombok.accessors.fluent</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>fluent</code> parameter, will act as if <code>@Accessors(fluent = true)</code> is present.</dd> + <dt><code>lombok.accessors.prefix</code> += <em>a field prefix</em> (default: empty list)</dt> + <dd>This is a list property; entries can be added with the <code>+=</code> operator. Inherited prefixes from parent config files can be removed with the <code>-=</code> operator. Any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>prefix</code> parameter, will act as if <code>@Accessors(prefix = {<em>prefixes listed in configuration</em>})</code> is present.</dd> + <dt><code>lombok.accessors.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Accessors</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/Builder.html b/website/features/experimental/Builder.html index 84452299..a8e21b9a 100644 --- a/website/features/experimental/Builder.html +++ b/website/features/experimental/Builder.html @@ -91,6 +91,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.builder.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Builder</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/Delegate.html b/website/features/experimental/Delegate.html index 41a36d82..bd4fc393 100644 --- a/website/features/experimental/Delegate.html +++ b/website/features/experimental/Delegate.html @@ -59,6 +59,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.delegate.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@Delegate</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/ExtensionMethod.html b/website/features/experimental/ExtensionMethod.html index b2c751b9..58aaf1b3 100644 --- a/website/features/experimental/ExtensionMethod.html +++ b/website/features/experimental/ExtensionMethod.html @@ -77,6 +77,13 @@ System.out.println(x.or("Hello, World!"));</pre> </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.extensionMethod.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@ExtensionMethod</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/FieldDefaults.html b/website/features/experimental/FieldDefaults.html index 159938a5..12ea7d80 100644 --- a/website/features/experimental/FieldDefaults.html +++ b/website/features/experimental/FieldDefaults.html @@ -56,6 +56,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.fieldDefaults.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@FieldDefaults</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/Wither.html b/website/features/experimental/Wither.html index 12475f6e..9ca43a46 100644 --- a/website/features/experimental/Wither.html +++ b/website/features/experimental/Wither.html @@ -62,6 +62,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <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> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> diff --git a/website/features/experimental/index.html b/website/features/experimental/index.html index 2c641228..f37712e0 100644 --- a/website/features/experimental/index.html +++ b/website/features/experimental/index.html @@ -38,6 +38,13 @@ <dd>Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating.</dd> </dl> </div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.experimental.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of any of the features listed here as a warning or error if configured.</dd> + </dl> + </div> <div class="index overview"> <h3>Putting the "Ex" in "Experimental": promoted or deleted experimental features.</h3> <dl> diff --git a/website/features/features.css b/website/features/features.css index 0d5c8102..b3017fe8 100644 --- a/website/features/features.css +++ b/website/features/features.css @@ -1,3 +1,7 @@ +.confType { + font-weight: bold; +} + body { font-family: Verdana; background-image: url(gradient.png); @@ -127,6 +131,10 @@ dd { font-size: 14px; } +.snippet.example { + margin: 8px 16px 8px 16px; +} + .footer { clear: left; margin: 0 auto 0 auto; diff --git a/website/features/index.html b/website/features/index.html index 74c1afcd..09a148f0 100644 --- a/website/features/index.html +++ b/website/features/index.html @@ -40,7 +40,9 @@ <dd>Laziness is a virtue!</dd> <dt><a href="Log.html"><code>@Log</code></a></dt> <dd>Captain's Log, stardate 24435.7: "What was that line again?"</dd> - <dt><a href="experimental/index.html">experimental features</a></dt> + <dt><a href="configuration.html">Configuration system</a></dt> + <dd>Lombok, made to order: Configure lombok features in one place for your entire project or even your workspace.</dd> + <dt><a href="experimental/index.html">Experimental features</a></dt> <dd>Here be dragons: Extra features which aren't quite ready for prime time yet.</dd> </dl> </div> diff --git a/website/features/val.html b/website/features/val.html index c4c8ad27..84158d27 100644 --- a/website/features/val.html +++ b/website/features/val.html @@ -38,6 +38,13 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.val.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>val</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> |