projectlombok#2596 Builder's setter prefix configurable from lombok.c…

…onfig
sadv1r · May 20, 2021 · 384aec3 · 384aec3
1 parent 6758714
commit 384aec3
Show file tree

Hide file tree

Showing 9 changed files with 106 additions and 8 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -13,6 +13,7 @@ DaveLaw <project.lombok@apconsult.de>
 Dave Brosius <dbrosius@mebigfatguy.com>
 Dawid Rusin <dawidrusin90@gmail.com>
 Denis Stepanov <denis.stepanov@gmail.com>
+Dmitry Ivanov <sadv12@gmail.com>
 Emil Lundberg <emil@yubico.com>
 Enrique da Costa Cambio <enrique.dacostacambio@gmail.com>
 Jacob Middag <jacob@gaddim.nl>

diff --git a/src/core/lombok/ConfigurationKeys.java b/src/core/lombok/ConfigurationKeys.java
@@ -299,6 +299,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}.
 	 * 

diff --git a/src/core/lombok/core/handlers/HandlerUtil.java b/src/core/lombok/core/handlers/HandlerUtil.java
@@ -845,4 +845,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;
+	}
 }
diff --git a/src/core/lombok/eclipse/handlers/HandleBuilder.java b/src/core/lombok/eclipse/handlers/HandleBuilder.java
@@ -315,7 +315,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) {
@@ -478,7 +478,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);
@@ -547,7 +547,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()));
 		}
 
 		{
@@ -594,7 +594,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);
 		}

diff --git a/src/core/lombok/javac/handlers/HandleBuilder.java b/src/core/lombok/javac/handlers/HandleBuilder.java
@@ -256,7 +256,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) {
@@ -417,7 +417,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);
@@ -484,7 +484,7 @@ static class BuilderFieldData {
 		}
 
 		for (BuilderFieldData bfd : job.builderFields) {
-			makePrefixedSetterMethodsForBuilder(job, bfd, annInstance.setterPrefix());
+			makePrefixedSetterMethodsForBuilder(job, bfd, getBuilderSetterPrefix(annotationNode, annInstance.setterPrefix()));
 		}
 
 		{
@@ -535,7 +535,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);

diff --git a/test/transform/resource/after-delombok/BuilderSimpleWithSetterPrefixConfiguration.java b/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>();
+	}
+}
diff --git a/test/transform/resource/after-ecj/BuilderSimpleWithSetterPrefixConfiguration.java b/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>();
+  }
+}
diff --git a/test/transform/resource/before/BuilderSimpleWithSetterPrefixConfiguration.java b/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;
+}
diff --git a/website/templates/features/Builder.html b/website/templates/features/Builder.html
@@ -171,6 +171,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>