#2596 Builder's setter prefix configurable from lombok.config

AUTHORS

@@ -13,6 +13,7 @@ DaveLaw <[email protected]>
 Dave Brosius <[email protected]>
 Dawid Rusin <[email protected]>
 Denis Stepanov <[email protected]>
+Dmitry Ivanov <[email protected]>
 Emil Lundberg <[email protected]>
 Enrique da Costa Cambio <[email protected]>
 Jacob Middag <[email protected]>

src/core/lombok/ConfigurationKeys.java

@@ -300,6 +300,13 @@ private ConfigurationKeys() {}
 	 */
 	public static final ConfigurationKey<String> BUILDER_CLASS_NAME = new ConfigurationKey<String>("lombok.builder.className", "Default name of the generated builder class. A * is replaced with the name of the relevant type (default = *Builder).") {};
 
+	/**
+	 * lombok configuration: {@code lombok.builder.setterPrefix} = &lt;String: prefix&gt;.
+	 *
+	 * For any usage of the {@code @Builder} annotation without an explicit {@code setterPrefix} parameter, this prefix is used.
+	 */
+	public static final ConfigurationKey<String> BUILDER_SETTER_PREFIX = new ConfigurationKey<String>("lombok.builder.setterPrefix", "The prefix to prepend to generated @Builder setter method names") {};
+
 	/**
 	 * lombok configuration: {@code lombok.builder.flagUsage} = {@code WARNING} | {@code ERROR}.
 	 * 

src/core/lombok/core/handlers/HandlerUtil.java

@@ -863,4 +863,15 @@ public static String getParamJavadoc(String methodComment, String param) {
 		}
 		return null;
 	}
+
+	public static String getBuilderSetterPrefix(LombokNode<?, ?, ?> node, String setterPrefix) {
+		if (setterPrefix != null && !setterPrefix.isEmpty()) {
+			return setterPrefix;
+		}
+
+		String configurationPrefix = node.getAst().readConfiguration(ConfigurationKeys.BUILDER_SETTER_PREFIX);
+		if (configurationPrefix != null && !configurationPrefix.isEmpty()) return configurationPrefix;
+
+		return setterPrefix;
+	}
 }

src/core/lombok/eclipse/handlers/HandleBuilder.java

@@ -320,7 +320,7 @@ private static final char[] prefixWith(char[] prefix, char[] name) {
 				bfd.builderFieldName = bfd.name;
 				bfd.annotations = copyAnnotations(fd, findCopyableAnnotations(fieldNode));
 				bfd.type = fd.type;
-				bfd.singularData = getSingularData(fieldNode, ast, annInstance.setterPrefix());
+				bfd.singularData = getSingularData(fieldNode, ast, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 				bfd.originalFieldNode = fieldNode;
 
 				if (bfd.singularData != null && isDefault != null) {
@@ -483,7 +483,7 @@ private static final char[] prefixWith(char[] prefix, char[] name) {
 				bfd.builderFieldName = bfd.name;
 				bfd.annotations = copyAnnotations(arg, copyableAnnotations);
 				bfd.type = arg.type;
-				bfd.singularData = getSingularData(param, ast, annInstance.setterPrefix());
+				bfd.singularData = getSingularData(param, ast, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 				bfd.originalFieldNode = param;
 				addObtainVia(bfd, param);
 				job.builderFields.add(bfd);
@@ -552,7 +552,7 @@ private static final char[] prefixWith(char[] prefix, char[] name) {
 		}
 
 		for (BuilderFieldData bfd : job.builderFields) {
-			makePrefixedSetterMethodsForBuilder(job, bfd, annInstance.setterPrefix());
+			makePrefixedSetterMethodsForBuilder(job, bfd, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 		}
 
 		{
@@ -599,7 +599,7 @@ private static final char[] prefixWith(char[] prefix, char[] name) {
 					tps[i].name = typeArgsForToBuilder.get(i);
 				}
 			}
-			MethodDeclaration md = generateToBuilderMethod(job, tps, annInstance.setterPrefix());
+			MethodDeclaration md = generateToBuilderMethod(job, tps, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 
 			if (md != null) injectMethod(job.parentType, md);
 		}

src/core/lombok/javac/handlers/HandleBuilder.java

@@ -261,7 +261,7 @@ static class BuilderFieldData {
 				bfd.builderFieldName = bfd.name;
 				bfd.annotations = findCopyableAnnotations(fieldNode);
 				bfd.type = fd.vartype;
-				bfd.singularData = getSingularData(fieldNode, annInstance.setterPrefix());
+				bfd.singularData = getSingularData(fieldNode, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 				bfd.originalFieldNode = fieldNode;
 
 				if (bfd.singularData != null && isDefault != null) {
@@ -422,7 +422,7 @@ static class BuilderFieldData {
 				bfd.rawName = raw.name;
 				bfd.annotations = findCopyableAnnotations(param);
 				bfd.type = raw.vartype;
-				bfd.singularData = getSingularData(param, annInstance.setterPrefix());
+				bfd.singularData = getSingularData(param, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 				bfd.originalFieldNode = param;
 				addObtainVia(bfd, param);
 				job.builderFields.add(bfd);
@@ -489,7 +489,7 @@ static class BuilderFieldData {
 		}
 
 		for (BuilderFieldData bfd : job.builderFields) {
-			makePrefixedSetterMethodsForBuilder(job, bfd, annInstance.setterPrefix());
+			makePrefixedSetterMethodsForBuilder(job, bfd, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 		}
 
 		{
@@ -540,7 +540,7 @@ static class BuilderFieldData {
 					}
 					tps = lb.toList();
 				}
-				JCMethodDecl md = generateToBuilderMethod(job, tps, annInstance.setterPrefix());
+				JCMethodDecl md = generateToBuilderMethod(job, tps, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 				if (md != null) {
 					recursiveSetGeneratedBy(md, annotationNode);
 					injectMethod(job.parentType, md);

test/transform/resource/after-delombok/BuilderSimpleWithSetterPrefixConfiguration.java

@@ -0,0 +1,37 @@
+import java.util.List;
+class BuilderSimpleWithSetterPrefix<T> {
+	private int unprefixed;
+	@java.lang.SuppressWarnings("all")
+	BuilderSimpleWithSetterPrefix(final int unprefixed) {
+		this.unprefixed = unprefixed;
+	}
+	@java.lang.SuppressWarnings("all")
+	protected static class BuilderSimpleWithSetterPrefixBuilder<T> {
+		@java.lang.SuppressWarnings("all")
+		private int unprefixed;
+		@java.lang.SuppressWarnings("all")
+		BuilderSimpleWithSetterPrefixBuilder() {
+		}
+		/**
+		 * @return {@code this}.
+		 */
+		@java.lang.SuppressWarnings("all")
+		public BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T> withUnprefixed(final int unprefixed) {
+			this.unprefixed = unprefixed;
+			return this;
+		}
+		@java.lang.SuppressWarnings("all")
+		public BuilderSimpleWithSetterPrefix<T> build() {
+			return new BuilderSimpleWithSetterPrefix<T>(this.unprefixed);
+		}
+		@java.lang.Override
+		@java.lang.SuppressWarnings("all")
+		public java.lang.String toString() {
+			return "BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder(unprefixed=" + this.unprefixed + ")";
+		}
+	}
+	@java.lang.SuppressWarnings("all")
+	protected static <T> BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T> builder() {
+		return new BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T>();
+	}
+}

test/transform/resource/after-ecj/BuilderSimpleWithSetterPrefixConfiguration.java

@@ -0,0 +1,30 @@
+import java.util.List;
+@lombok.Builder(access = lombok.AccessLevel.PROTECTED) class BuilderSimpleWithSetterPrefix<T> {
+  protected static @java.lang.SuppressWarnings("all") class BuilderSimpleWithSetterPrefixBuilder<T> {
+    private @java.lang.SuppressWarnings("all") int unprefixed;
+    @java.lang.SuppressWarnings("all") BuilderSimpleWithSetterPrefixBuilder() {
+      super();
+    }
+    /**
+     * @return {@code this}.
+     */
+    public @java.lang.SuppressWarnings("all") BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T> withUnprefixed(final int unprefixed) {
+      this.unprefixed = unprefixed;
+      return this;
+    }
+    public @java.lang.SuppressWarnings("all") BuilderSimpleWithSetterPrefix<T> build() {
+      return new BuilderSimpleWithSetterPrefix<T>(this.unprefixed);
+    }
+    public @java.lang.Override @java.lang.SuppressWarnings("all") java.lang.String toString() {
+      return (("BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder(unprefixed=" + this.unprefixed) + ")");
+    }
+  }
+  private int unprefixed;
+  @java.lang.SuppressWarnings("all") BuilderSimpleWithSetterPrefix(final int unprefixed) {
+    super();
+    this.unprefixed = unprefixed;
+  }
+  protected static @java.lang.SuppressWarnings("all") <T>BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T> builder() {
+    return new BuilderSimpleWithSetterPrefix.BuilderSimpleWithSetterPrefixBuilder<T>();
+  }
+}

test/transform/resource/before/BuilderSimpleWithSetterPrefixConfiguration.java

@@ -0,0 +1,8 @@
+//CONF: lombok.builder.setterPrefix = with
+
+import java.util.List;
+
+@lombok.Builder(access = lombok.AccessLevel.PROTECTED)
+class BuilderSimpleWithSetterPrefix<T> {
+	private int unprefixed;
+}

website/templates/features/Builder.html

@@ -187,6 +187,10 @@ <h3 id="jackson"><a name="jackson">With Jackson</a></h3>
 			<code>lombok.builder.className</code> = [a java identifier with an optional star to indicate where the return type name goes] (default: <code>*Builder</code>)
 		</dt><dd>
 			Unless you explicitly pick the builder's class name with the <code>builderClassName</code> parameter, this name is chosen; any star in the name is replaced with the relevant return type.
+		</dd><dt>
+			<code>lombok.builder.setterPrefix</code> = [the prefix to prepend to generated <code>@Builder</code> setter method names] (default: not set)
+		</dt><dd>
+			Unless you explicitly pick the builder's setter prefix with the <code>setterPrefix</code> parameter, this prefix is chosen.
 		</dd><dt>
 			<code>lombok.builder.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)
 		</dt><dd>