From 2baefe08cedebc9ef8c468b7de353e66b23eded1 Mon Sep 17 00:00:00 2001 From: Caleb Brinkman Date: Wed, 11 Sep 2019 09:20:39 -0500 Subject: Explicitly recommend against prefixes --- src/core/lombok/Builder.java | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src') diff --git a/src/core/lombok/Builder.java b/src/core/lombok/Builder.java index d7fe42a1..fcbe1a09 100644 --- a/src/core/lombok/Builder.java +++ b/src/core/lombok/Builder.java @@ -160,6 +160,9 @@ public @interface Builder { * * For example, a method normally generated as {@code someField(String someField)} would instead be generated as {@code withSomeField(String someField)} * + * 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. + * * @return The prefix to prepend to generated method names. */ String setterPrefix() default ""; -- cgit