* @Builder
- * class Example {
- * private int foo;
+ * class Example<T> {
+ * private T foo;
* private final String bar;
* }
*
@@ -103,6 +103,8 @@ import java.lang.annotation.Target;
* }
* }
*
+ *
+ * @see Singular
*/
@Target({TYPE, METHOD, CONSTRUCTOR})
@Retention(SOURCE)
@@ -131,48 +133,6 @@ public @interface Builder {
*/
String builderClassName() default "";
- /**
- * Should the generated builder extend the parent class's builder?
- *
- * If {@code true}, the generated builder class will extend the builder of the
- * superclass. This means the builder also contains the methods for fields from
- * the superclass.
- * - * Note that both this builder and the superclass' builder must be a builder - * for a type (so, not for a static method or a constructor). You must mark - * the parent extendable: {@code @Builder(extensible = true)}. - *
- * This builder will also be {@code extensible = true} if you set {@code inherit = true}. - * - * @see #extensible() - */ - boolean inherit() default false; - - /** - * Should the generated builder be extensible by subclasses? - * - * If {@code true} the generated builder class will be extensible by - * {@code @Builder} classes of this class's subclasses, by marking them - * with {@code @Builder(inherit = true)}. - *
- * The {@code @Builder} extensible system only works for {@code @Builder} - * annotations on types (so, not on a static method or a constructor). - * - * @see #inherit() - */ - boolean extensible() default false; - - /** - * Name of the builder class in the superclass. - * - * Only relevant if {@code inherit = true} - * - * Default: {@code (SuperclassTypeName)Builder}. - * - * @see #inherit() - */ - String superclassBuilderClassName() default ""; - /** * If true, generate an instance method to obtain a builder that is initialized with the values of this instance. * Legal only if {@code @Builder} is used on a constructor, on the type itself, or on a static method that returns diff --git a/src/core/lombok/experimental/SuperBuilder.java b/src/core/lombok/experimental/SuperBuilder.java new file mode 100644 index 00000000..26127a5f --- /dev/null +++ b/src/core/lombok/experimental/SuperBuilder.java @@ -0,0 +1,66 @@ +/* + * Copyright (C) 2018 The Project Lombok Authors. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +package lombok.experimental; + +import static java.lang.annotation.ElementType.*; +import static java.lang.annotation.RetentionPolicy.*; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import lombok.Singular; + +/** + * The SuperBuilder annotation creates a so-called 'builder' aspect to the class that is annotated with {@code @SuperBuilder}, but which works well when extending. + * It is similar to {@code @Builder}, except it is only legal on types, is less configurable, but allows you to {@code extends} other builder-able classes. + *
+ * 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 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}. */
+ 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";
+
+ // toBuilder also requires a two-stage system where each class gets its own toBuilder but calls on a second method (and also calls parentclass's method)
+ // to fill the builder, as this class does not know what fields to pass on to the builder. Let's consider this, but only for milestone 2.
+ /*
+ * If true, generate an instance method to obtain a builder that is initialized with the values of this instance.
+ *
+ * @return Whether to generate a {@code toBuilder()} method.
+ */
+// boolean toBuilder() default false;
+}
diff --git a/test/transform/resource/after-delombok/SuperBuilderBasic.java b/test/transform/resource/after-delombok/SuperBuilderBasic.java
new file mode 100644
index 00000000..ffb56e0e
--- /dev/null
+++ b/test/transform/resource/after-delombok/SuperBuilderBasic.java
@@ -0,0 +1,112 @@
+import java.util.List;
+
+public class SuperBuilderBasic {
+ public static class Parent {
+ int field1;
+ List