diff options
Diffstat (limited to 'website/templates/features')
| -rw-r--r-- | website/templates/features/ToString.html | 2 | ||||
| -rw-r--r-- | website/templates/features/experimental/FieldNameConstants.html | 2 | ||||
| -rw-r--r-- | website/templates/features/experimental/UtilityClass.html | 4 |
3 files changed, 6 insertions, 2 deletions
diff --git a/website/templates/features/ToString.html b/website/templates/features/ToString.html index 87e06649..c740ec81 100644 --- a/website/templates/features/ToString.html +++ b/website/templates/features/ToString.html @@ -3,7 +3,7 @@ <@f.scaffold title="@ToString" logline="No need to start a debugger to see your fields: Just let lombok generate a <code>toString</code> for you!"> <@f.overview> <p> - Any class definition may be annotated with <code>@ToString</code> to let lombok generate an implementation of the <code>toString()</code> method. By default, it'll print your class name, along with each field, in order, separated by commas. + Annotating a class with <code>@ToString</code> will cause lombok to generate an implementation of the <code>toString()</code> method. You use configuration options to specify whether field names should be included but otherwise the format is fixed: the class name followed by parentheses containing fields separated by commas, e.g. <code>MyClass(foo=123, bar=234)</code>. </p><p> By setting the <code>includeFieldNames</code> parameter to <em>true</em> you can add some clarity (but also quite some length) to the output of the <code>toString()</code> method. </p><p> diff --git a/website/templates/features/experimental/FieldNameConstants.html b/website/templates/features/experimental/FieldNameConstants.html index 06fa23b5..cc147d51 100644 --- a/website/templates/features/experimental/FieldNameConstants.html +++ b/website/templates/features/experimental/FieldNameConstants.html @@ -58,6 +58,8 @@ Any parameters of lombok annotations that take strings need to be supplied actual string literals; you cannot have references to constants like those generated by <code>@FieldNameConstants</code>. If you'd like to use <code>@FieldNameConstants</code> to for example fill in the <code>of</code> and/or <code>exclude</code> parameters of <code>@ToString</code> and similar lombok annotations, use the <code>@ToString.Include</code> / <code>@ToString.Exclude</code> etc system instead; these are described at the feature pages for those features. </p><p> Like other lombok handlers that touch fields, any field whose name starts with a dollar (<code>$</code>) symbol is skipped entirely. Such a field will not be modified at all. Static fields are also skipped. + </p><p> + <em>MapStruct interop:</em> When making references to field name constants inside MapStruct's <code>@Mapping</code>, and you use that annotation more than once on a node, you must manually wrap these in the <code>@Mappings</code> 'container annotation'. Like so: <code>@Mappings({@Mapping(target = Entity.Fields.entityProperty, source = "dtoProperty")})</code>. </p> </@f.smallPrint> </@f.scaffold> diff --git a/website/templates/features/experimental/UtilityClass.html b/website/templates/features/experimental/UtilityClass.html index c5f51e29..915fe5c9 100644 --- a/website/templates/features/experimental/UtilityClass.html +++ b/website/templates/features/experimental/UtilityClass.html @@ -11,9 +11,11 @@ <ul> <li> Some debate as to whether its common enough to count as boilerplate. + </li><li> + Due to limitations in javac, currently non-star static imports <em>cannot</em> be used to import stuff from <code>@UtilityClass</code>es; don't static import, or use star imports. </li> </ul> - Current status: <em>positive</em> - Currently we feel this feature may move out of experimental status with no or minor changes soon. + Current status: <em>negative</em> - Currently we feel this feature cannot move out of experimental status due to fundamental issues with non-star static imports. </@f.experimental> <@f.overview> |