diff options
author | Reinier Zwitserloot <r.zwitserloot@projectlombok.org> | 2020-03-05 23:15:25 +0100 |
---|---|---|
committer | Reinier Zwitserloot <r.zwitserloot@projectlombok.org> | 2020-03-05 23:20:53 +0100 |
commit | 2dc69359f024ac0c20916edd0ba43439393fb7ed (patch) | |
tree | 2dd7549e00d222bf6171ed2999e3d97119ff2ffe /website/templates/features | |
parent | ed412b7e091978e1363c91ba4c05aa304c4fb7d6 (diff) | |
download | lombok-2dc69359f024ac0c20916edd0ba43439393fb7ed.tar.gz lombok-2dc69359f024ac0c20916edd0ba43439393fb7ed.tar.bz2 lombok-2dc69359f024ac0c20916edd0ba43439393fb7ed.zip |
[trivial] minor updates to Jacksonized docs.
Diffstat (limited to 'website/templates/features')
4 files changed, 8 insertions, 7 deletions
diff --git a/website/templates/features/Builder.html b/website/templates/features/Builder.html index 23977837..f9897d03 100644 --- a/website/templates/features/Builder.html +++ b/website/templates/features/Builder.html @@ -74,6 +74,8 @@ </ul> Example usage where all options are changed from their defaults:<br /> <code>@Builder(builderClassName = "HelloWorldBuilder", buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true, access = AccessLevel.PRIVATE, setterPrefix = "set")</code><br /> + </p><p> + Looking to use your builder with <a href="https://github.com/FasterXML/jackson">Jackson</a>, the JSON/XML tool? We have you covered: Check out the <a href="/features/experimental/Jacksonized">@Jacksonized</a> feature. </p> </@f.overview> diff --git a/website/templates/features/experimental/Jacksonized.html b/website/templates/features/experimental/Jacksonized.html index fd2bfe68..1182bdef 100644 --- a/website/templates/features/experimental/Jacksonized.html +++ b/website/templates/features/experimental/Jacksonized.html @@ -1,6 +1,6 @@ <#import "../_features.html" as f> -<@f.scaffold title="@Jacksonized" logline="Make Jackson use your builders."> +<@f.scaffold title="@Jacksonized" logline="Bob, meet Jackson. Lets make sure you become fast friends."> <@f.history> <p> <code>@Jacksonized</code> was introduced as experimental feature in lombok v1.18.14. @@ -22,10 +22,7 @@ public class JacksonExample { } </pre></div></div> </p><p> - This annotation is especially useful when deserializing into immutable (sub-)classes that only use <code>@SuperBuilder</code> to create instances. - With <code>@Jacksonized</code>, you do not have to put the complex <code>@SuperBuilder</code> class header into your code just to configure it for Jackson. - </p><p> - This annotation does <i>not</i> change the behavior of the generated builder. + This annotation does <em>not</em> change the behavior of the generated builder. A <code>@Jacksonized</code> <code>@SuperBuilder</code> remains fully compatible to regular <code>@SuperBuilder</code>s. </p> </@f.overview> @@ -35,7 +32,7 @@ public class JacksonExample { In particular, the annotation does the following: <ul> <li> - Configure Jackson to use the builder for deserialization using <code>@JsonDeserialize(builder=<em>Foobar</em>.<em>Foobar</em>Builder[Impl].class))</code> on the class (where <em>Foobar</em> is the name of the annotated class). + Configure Jackson to use the builder for deserialization using <code>@JsonDeserialize(builder=<em>Foobar</em>.<em>Foobar</em>Builder[Impl].class))</code> on the class (where <em>Foobar</em> is the name of the annotated class, and <code>Impl</code> is added for <code>@SuperBuilder</code>). (An error is emitted if such an annotation already exists.) </li><li> Copy Jackson-related configuration annotations (like <code>@JsonIgnoreProperties</code>) from the class to the builder class. diff --git a/website/templates/features/experimental/SuperBuilder.html b/website/templates/features/experimental/SuperBuilder.html index 0fa81073..c929e8f5 100644 --- a/website/templates/features/experimental/SuperBuilder.html +++ b/website/templates/features/experimental/SuperBuilder.html @@ -49,6 +49,8 @@ </ul> Example usage where all options are changed from their defaults:<br /> <code>@SuperBuilder(buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true, setterPrefix = "set")</code><br /> + </p><p> + Looking to use your superbuilder with <a href="https://github.com/FasterXML/jackson">Jackson</a>, the JSON/XML tool? We have you covered: Check out the <a href="/features/experimental/Jacksonized">@Jacksonized</a> feature. </p> </@f.overview> diff --git a/website/templates/features/experimental/index.html b/website/templates/features/experimental/index.html index dc7870cf..32590815 100644 --- a/website/templates/features/experimental/index.html +++ b/website/templates/features/experimental/index.html @@ -73,7 +73,7 @@ </@main.feature> <@main.feature title="@Jacksonized" href="Jacksonized"> - Make Jackson use your builders. + Bob, meet Jackson. Lets make sure you become fast friends. </@main.feature> </div> |