+ * All classes in the hierarchy must be annotated with {@code @SuperBuilder}. + *
+ * Lombok generates 2 inner 'builder' classes, which extend the parent class' builder class (unless your class doesn't have an extends clause). + * Lombok also generates a static method named {@code builder()}, and a protected constructor that takes 1 argument of the builderclass type. + *
+ * The TBuilder class contains 1 method for each parameter of the annotated
+ * constructor / method (each field, when annotating a class), which returns the builder itself.
+ * The builder also has a {@code build()} method which returns a completed instance of the original type.
+ *
+ * Complete documentation is found at the project lombok features page for @SuperBuilder.
+ *
+ * @see Singular
+ */
+@Target(TYPE)
+@Retention(SOURCE)
+public @interface SuperBuilder {
+ /** @return Name of the method that creates a new builder instance. Default: {@code builder}. If the empty string, suppress generating the {@code builder} method. */
+ String builderMethodName() default "builder";
+
+ /** @return Name of the method in the builder class that creates an instance of your {@code @Builder}-annotated class. */
+ String buildMethodName() default "build";
+
+ /**
+ * If {@code true}, generate an instance method to obtain a builder that is initialized with the values of this instance.
+ * In this case, all superclasses must also have {@code toBuilder=true}.
+ *
+ * @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 "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 "";
+}
diff --git a/src/core/lombok/core/LombokInternalAliasing.java b/src/core/lombok/core/LombokInternalAliasing.java
index 60dea0f2..f31e7363 100644
--- a/src/core/lombok/core/LombokInternalAliasing.java
+++ b/src/core/lombok/core/LombokInternalAliasing.java
@@ -47,6 +47,7 @@ public class LombokInternalAliasing {
m1.put("lombok.experimental.var", "lombok.var");
m1.put("lombok.Delegate", "lombok.experimental.Delegate");
m1.put("lombok.experimental.Wither", "lombok.With");
+ m1.put("lombok.experimental.SuperBuilder", "lombok.SuperBuilder");
ALIASES = Collections.unmodifiableMap(m1);
Map
+ * NB: {@code @SuperBuilder} has been moved to the main package; update your lombok dependencies and search/replace all {@code import lombok.experimental.SuperBuilder} to {@code import lombok.SuperBuilder}.
+ *
* All classes in the hierarchy must be annotated with {@code @SuperBuilder}.
*
* Lombok generates 2 inner 'builder' classes, which extend the parent class' builder class (unless your class doesn't have an extends clause).
@@ -42,10 +44,11 @@ import lombok.Singular;
* constructor / method (each field, when annotating a class), which returns the builder itself.
* The builder also has a {@code build()} method which returns a completed instance of the original type.
*
- * Complete documentation is found at the project lombok features page for @SuperBuilder.
+ * Complete documentation is found at the project lombok features page for @SuperBuilder.
*
* @see Singular
*/
+// @Deprecated // First release on or after 2027-06-01: Deprecate this type, with text: @deprecated {@code SuperBuilder} has been promoted to the main package; use {@link lombok.SuperBuilder} instead.
@Target(TYPE)
@Retention(SOURCE)
public @interface SuperBuilder {
diff --git a/src/core/lombok/extern/jackson/Jacksonized.java b/src/core/lombok/extern/jackson/Jacksonized.java
index 059c93d7..d75b327f 100644
--- a/src/core/lombok/extern/jackson/Jacksonized.java
+++ b/src/core/lombok/extern/jackson/Jacksonized.java
@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
import lombok.Builder;
import lombok.experimental.Accessors;
-import lombok.experimental.SuperBuilder;
+import lombok.SuperBuilder;
/**
* The {@code @Jacksonized} annotation is an add-on annotation for
diff --git a/src/core/lombok/javac/handlers/HandleBuilderDefault.java b/src/core/lombok/javac/handlers/HandleBuilderDefault.java
index 8438057a..bf7435f5 100644
--- a/src/core/lombok/javac/handlers/HandleBuilderDefault.java
+++ b/src/core/lombok/javac/handlers/HandleBuilderDefault.java
@@ -31,7 +31,7 @@ import lombok.Builder;
import lombok.core.AST.Kind;
import lombok.core.AnnotationValues;
import lombok.core.HandlerPriority;
-import lombok.experimental.SuperBuilder;
+import lombok.SuperBuilder;
import lombok.javac.JavacAnnotationHandler;
import lombok.javac.JavacNode;
import lombok.spi.Provides;
@@ -44,7 +44,7 @@ public class HandleBuilderDefault extends JavacAnnotationHandler