diff options
| author | Reinier Zwitserloot <reinier@zwitserloot.com> | 2020-02-08 22:27:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-08 22:27:03 +0100 |
| commit | d1c81abc13577edf95ee13a6f0c48e58bf5947bc (patch) | |
| tree | a68700c831edbf056fa1f8773e7ef9c941eab982 /src/core/lombok/experimental | |
| parent | cf4e59662a8aac42beee50d2fc28487b7aaf9ea6 (diff) | |
| parent | 6e2d23fdd7613de9650ffaf00c6e24a6ead0d74b (diff) | |
| download | lombok-d1c81abc13577edf95ee13a6f0c48e58bf5947bc.tar.gz lombok-d1c81abc13577edf95ee13a6f0c48e58bf5947bc.tar.bz2 lombok-d1c81abc13577edf95ee13a6f0c48e58bf5947bc.zip | |
Merge pull request #2357 from janrieke/superBuilderSetterPrefix
setter prefixes for SuperBuilder
Diffstat (limited to 'src/core/lombok/experimental')
| -rw-r--r-- | src/core/lombok/experimental/SuperBuilder.java | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/core/lombok/experimental/SuperBuilder.java b/src/core/lombok/experimental/SuperBuilder.java index aef76a46..0733a616 100644 --- a/src/core/lombok/experimental/SuperBuilder.java +++ b/src/core/lombok/experimental/SuperBuilder.java @@ -62,4 +62,23 @@ public @interface SuperBuilder { * @return Whether to generate a {@code toBuilder()} method. */ boolean toBuilder() default false; + + /** + * Prefix to prepend to 'set' methods in the generated builder class. By default, generated methods do not include a prefix. + * + * For example, a method normally generated as {@code someField(String someField)} would instead be + * generated as {@code withSomeField(String someField)} if using {@code @SuperBuilder(setterPrefix = "with")}. + * + * Note that using "with" to prefix builder setter methods is strongly discouraged as as "with" normally + * suggests immutable data structures, and builders by definition are mutable objects. + * + * For {@code @Singular} fields, the generated methods are called {@code withName}, {@code withNames}, and {@code clearNames}, instead of + * the default {@code name}, {@code names}, and {@code clearNames}. + * + * This prefix only applies to the 'set' methods for the fields of the annotated class. + * For consistency reasons, you should use the same prefix on all superclasses and subclasses that use {@code @SuperBuilder}. + * + * @return The prefix to prepend to generated method names. + */ + String setterPrefix() default ""; } |