From 2dc69359f024ac0c20916edd0ba43439393fb7ed Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Thu, 5 Mar 2020 23:15:25 +0100 Subject: [trivial] minor updates to Jacksonized docs. --- doc/changelog.markdown | 4 ++-- website/templates/features/Builder.html | 2 ++ website/templates/features/experimental/Jacksonized.html | 9 +++------ website/templates/features/experimental/SuperBuilder.html | 2 ++ website/templates/features/experimental/index.html | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/changelog.markdown b/doc/changelog.markdown index 9f0e2242..001302c0 100644 --- a/doc/changelog.markdown +++ b/doc/changelog.markdown @@ -2,13 +2,13 @@ Lombok Changelog ---------------- ### v1.18.13 "Edgy Guinea Pig" -* BREAKING CHANGE: mapstruct users should not add a dependency to lombok-mapstruct-binding. This solves compiling modules with lombok (and mapstruct). +* BREAKING CHANGE: mapstruct users should now add a dependency to lombok-mapstruct-binding. This solves compiling modules with lombok (and mapstruct). * FEATURE: Similar to `@Builder`, you can now configure a `@SuperBuilder`'s 'setter' prefixes via `@SuperBuilder(setterPrefix = "set")` for example. We still discourage doing this. [Pull Request #2357](https://github.com/rzwitserloot/lombok/pull/2357). * FEATURE: If using `@Synchronized("lockVar")`, if `lockVar` is referring to a static field, the code lombok generates no longer causes a warning about accessing a static entity incorrectly. [Issue #678](https://github.com/rzwitserloot/lombok/issues/678) * BUGFIX: Using `@SuperBuilder` on a class that has some fairly convoluted generics usage would fail with 'Wrong number of type arguments'. [Issue #2359](https://github.com/rzwitserloot/lombok/issues/2359) [Pull Request #2362](https://github.com/rzwitserloot/lombok/pull/2362) * BUGFIX: Various lombok annotations on classes nested inside enums or interfaces would cause errors in eclipse. [Issue #2369](https://github.com/rzwitserloot/lombok/issues/2369) * BUGFIX: Trying to add `@ExtensionMethod`s with exactly 2 arguments would fail in eclipse. [Issue #1441](https://github.com/rzwitserloot/lombok/issues/1441) [Pull Request #2376](https://github.com/rzwitserloot/lombok/pull/2376) thanks to __@Rawi01__. -* FEATURE: `@Jacksonized` on a `@Builder` or `@SuperBuilder` will configure [Jackson](https://github.com/FasterXML/jackson) to use this builder when deserializing. [Pull Request #2387](https://github.com/rzwitserloot/lombok/pull/2387). [@Jacksonized documentation](https://projectlombok.org/features/experimental/Jacksonized). +* FEATURE: `@Jacksonized` on a `@Builder` or `@SuperBuilder` will configure [Jackson](https://github.com/FasterXML/jackson) to use this builder when deserializing. [Pull Request #2387](https://github.com/rzwitserloot/lombok/pull/2387) thanks to __@JanRieke__. [@Jacksonized documentation](https://projectlombok.org/features/experimental/Jacksonized). ### v1.18.12 (February 1st, 2020) * PLATFORM: Support for JDK13 (including `yield` in switch expressions, as well as delombok having a nicer style for arrow-style switch blocks, and text blocks). 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 @@ Example usage where all options are changed from their defaults:
@Builder(builderClassName = "HelloWorldBuilder", buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true, access = AccessLevel.PRIVATE, setterPrefix = "set")
+

+ Looking to use your builder with Jackson, the JSON/XML tool? We have you covered: Check out the @Jacksonized feature.

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>

@Jacksonized was introduced as experimental feature in lombok v1.18.14. @@ -22,10 +22,7 @@ public class JacksonExample { }

- This annotation is especially useful when deserializing into immutable (sub-)classes that only use @SuperBuilder to create instances. - With @Jacksonized, you do not have to put the complex @SuperBuilder class header into your code just to configure it for Jackson. -

- This annotation does not change the behavior of the generated builder. + This annotation does not change the behavior of the generated builder. A @Jacksonized @SuperBuilder remains fully compatible to regular @SuperBuilders.

@@ -35,7 +32,7 @@ public class JacksonExample { In particular, the annotation does the following: Example usage where all options are changed from their defaults:
@SuperBuilder(buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true, setterPrefix = "set")
+

+ Looking to use your superbuilder with Jackson, the JSON/XML tool? We have you covered: Check out the @Jacksonized feature.

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 title="@Jacksonized" href="Jacksonized"> - Make Jackson use your builders. + Bob, meet Jackson. Lets make sure you become fast friends. -- cgit