Explain builder default gotchas #3560
Conversation
| @@ -66,7 +66,7 @@ | |||
| </p><p> | |||
| Now that the "method" mode is clear, putting a <code>@Builder</code> annotation on a constructor functions similarly; effectively, constructors are just static methods that have a special syntax to invoke them: Their 'return type' is the class they construct, and their type parameters are the same as the type parameters of the class itself. | |||
| </p><p> | |||
| Finally, applying <code>@Builder</code> to a class is as if you added <code>@AllArgsConstructor(access = AccessLevel.PACKAGE)</code> to the class and applied the <code>@Builder</code> annotation to this all-args-constructor. This only works if you haven't written any explicit constructors yourself. If you do have an explicit constructor, put the <code>@Builder</code> annotation on the constructor instead of on the class. Note that if you put both `@Value` and `@Builder` on a class, the package-private constructor that `@Builder` wants to generate 'wins' and suppresses the constructor that `@Value` wants to make. | |||
| Finally, applying <code>@Builder</code> to a class is as if you added <code>@AllArgsConstructor(access = AccessLevel.PACKAGE)</code> to the class and applied the <code>@Builder</code> annotation to this all-args-constructor. This only works if you haven't written any explicit constructors yourself or created one with @NoArgsConstructor. If you do have an explicit constructor, put the <code>@Builder</code> annotation on the constructor instead of on the class. Note that if you put both `@Value` and `@Builder` on a class, the package-private constructor that `@Builder` wants to generate 'wins' and suppresses the constructor that `@Value` wants to make. | |||
There was a problem hiding this comment.
chatGPT rephrases it:
Applying @Builder to a class is equivalent to adding @AllArgsConstructor(access = AccessLevel.PACKAGE) to the class and applying the @Builder annotation to this all-args constructor. This mechanism is effective only when explicit constructors or constructors created with @NoArgsConstructor are absent. If an explicit constructor is present, it's recommended to place the @Builder annotation on the constructor instead of the class. It's worth noting that when both @Value and @Builder are used in a class, the package-private constructor intended by @Builder takes precedence and suppresses the constructor specified by @Value
As non-native speaker i find it's easier to understand.
|
Thanks, Mat |
|
I accepted this then immediately updated the text. The gotcha on the gotcha is: |
No description provided.