aboutsummaryrefslogtreecommitdiff
path: root/src/core/lombok
diff options
context:
space:
mode:
authorCaleb Brinkman <cbrinkman@sonatype.com>2019-09-11 09:20:39 -0500
committerCaleb Brinkman <cbrinkman@sonatype.com>2019-09-11 09:20:39 -0500
commit2baefe08cedebc9ef8c468b7de353e66b23eded1 (patch)
tree1282b2ba64cbe15fbd819937136763ede845152e /src/core/lombok
parentdc56309dada0ae0fba2c939d3fc300d6abac145c (diff)
downloadlombok-2baefe08cedebc9ef8c468b7de353e66b23eded1.tar.gz
lombok-2baefe08cedebc9ef8c468b7de353e66b23eded1.tar.bz2
lombok-2baefe08cedebc9ef8c468b7de353e66b23eded1.zip
Explicitly recommend against prefixes
Diffstat (limited to 'src/core/lombok')
-rw-r--r--src/core/lombok/Builder.java3
1 files changed, 3 insertions, 0 deletions
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 "";