From 60611d94cf40c8cfe9bdb2df80f43dc6b6ad85ff Mon Sep 17 00:00:00 2001 From: Filip Hrisafov Date: Sat, 3 Nov 2018 09:03:22 +0100 Subject: [PATCH] Add more info for the FreeBuilder support in the documentation * Add the usage of the FreeBuilderAccessorNamingStrategy when FreeBuilder is present * And the fact that the JavaBean convention should be followed when using FreeBuilder --- .../src/main/asciidoc/mapstruct-reference-guide.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/src/main/asciidoc/mapstruct-reference-guide.asciidoc b/documentation/src/main/asciidoc/mapstruct-reference-guide.asciidoc index 9bdc041e3..be998a3b8 100644 --- a/documentation/src/main/asciidoc/mapstruct-reference-guide.asciidoc +++ b/documentation/src/main/asciidoc/mapstruct-reference-guide.asciidoc @@ -731,7 +731,8 @@ Supported builder frameworks: * https://projectlombok.org/[Lombok] - requires having the Lombok classes in a separate module. See for more information https://github.com/rzwitserloot/lombok/issues/1538[rzwitserloot/lombok#1538] * https://github.com/google/auto/blob/master/value/userguide/index.md[AutoValue] * https://immutables.github.io/[Immutables] - When Immutables are present on the annotation processor path then the `ImmutablesAccessorNamingStrategy` and `ImmutablesBuilderProvider` would be used by default -* https://github.com/google/FreeBuilder[FreeBuilder] +* https://github.com/google/FreeBuilder[FreeBuilder] - When FreeBuilder is present on the annotation processor path then the `FreeBuilderAccessorNamingStrategy` would be used by default. +When using FreeBuilder then the JavaBean convention should be followed, otherwise MapStruct won't recognize the fluent getters. * It also works for custom builders (handwritten ones) if the implementation supports the defined rules for the default `BuilderProvider`. Otherwise, you would need to write a custom `BuilderProvider`