Spark Builder Generator

Eclipse plugin to generate builders.

You can find it on Eclipse marketplace here

Builder generator

Features:

• Generates a builder with custom name patterns
• Can generate staged builder
• Capable of regenerating the builder
• Compatible with most version of Eclipse
• Highly configurable, check the plugin's preferences page
• Capable of generate builder methods for visible fields in superclass
• Can generate a builder that can initialize a builder based on an already existing instance
• Encourages and supports null-safe programming practices
• Open source (with very permissible MIT license)

Contribution

Please check CONTRIBUTING.md

Configuration

Most configuration is on the preferences page: Preferences -> Java -> Spark builder generator

@Generated annotatation

• Generated annotation helps the plugin to determine what is safe to remove. If it is turned of the plugin makes a best guess which methods might have been generated by it, but might accidentally remove other methods as well.

Release notes:

• Pre 0.0.5 Base builder generator plugin
• 0.0.5 Add option to remove prefix and postfix from builder method name
• 0.0.6 Add staged builder option
• 0.0.7 Option to include visible fields from superclass
• 0.0.8 Regression bug was observed in 0.0.7 under some Eclipse configurations. IllegalArgumentException occured while trying to parse java.lang.Object class.
• 0.0.9 Generate builder to the class under the cursor (in case of nested classes, or multiple classes in a single file) Improvements to Builder class removing logic
• 0.0.10 Added the option to select which fields are generated in the builder Fixed a small bug that deleted the previous builder when pressing the cancel button on the staging builder generator dialog Added MIT license file to plugin installation license
• 0.0.11 Initialize Optional value to Optional.empty() to follow nullsafe programming practices Initialize Collections with empty collections via java.util.Collections class Various bugfixes related to overriding previous builder Logging improvement
• 0.0.12 Generate @param tag to the builder's "with" methods
• 0.0.13 Add fields from superclass' constructor to the builder
• 0.0.14 Add the ability to create a builder based on an already existing instance Dialog UX update
• 0.0.15 Add builder fields for private fields in superclass that have setters.
• 0.0.16 Generate Jackson deserialize annotations to the builder
• 0.0.17 Generate public default constructor
• 0.0.18 Fixed dialog issue when combined with DevStyle Darkest Dark plugin, also made dialogs more responsive and updated icon
• 0.0.19 Fixed ClassCastException when Java file includes an enum as the first type. JsonPOJOBuilder annotation is not generated when the default builder names is not overridden
• 0.0.20 Fixed regression issue caused by wrong target definition on compiling
• 0.0.21 Option to generate public constructor for regular builder that includes mandatory fields
• 0.0.22 Fixing incorrect field naming with underscore prefix
• 0.0.23 Add option to keep custom methods in the builderclass, when the builder is regenerated
• 0.0.24 Add option to initialize builder fields with default value from the class' field assignment
• 0.0.25 Fix default value initialization based on superclass' field assignment
• 0.0.26 Fix copy constructor when superclass field is not accessible from builder
• 0.0.27 Add option to use jakarta.annotation package instead of the old javax.annotation
• 0.0.28 Add support for record types
• 0.0.29 Don't generate constructor for record class
• 0.0.29 Change update site to github

The generated code looks like the following:

    public class Clazz {
        private Integer firstField;
        private Long secondField;

        @Generated("SparkTools")
        private Clazz(Builder builder) {
            this.firstField = builder.firstField;
            this.secondField = builder.secondField;
        }
        /**
         * Creates builder to build {@link Clazz}.
         * @return created builder
         */
        @Generated("SparkTools")
        public static Builder builder() {
            return new Builder();
        }
        /**
         * Builder to build {@link Clazz}.
         */
        @Generated("SparkTools")
        public static class Builder {
            private Integer firstField;
            private Long secondField;

            private Builder() {
            }

            /**
            * Builder method for firstField parameter.
            * @param firstField field to set
            * @return builder
            */
            @Nonnull
            public Builder withFirstField(@Nonnull Integer firstField) {
                this.firstField = firstField;
                return this;
            }

            /**
            * Builder method for secondField parameter.
            * @param secondField field to set
            * @return builder
            */
            @Nonnull
            public Builder withSecondField(@Nonnull Long secondField) {
                this.secondField = secondField;
                return this;
            }

            /**
            * Builder method of the builder.
            * @return built class
            */
            @Nonnull
            public Clazz build() {
                return new Clazz(this);
            }
        }
    }

Staged builder generated code example

public class Mail {
    private String from;
    private String to;
    private String subject;
    private String content;
    private String mimeType; // optional

    @Generated("SparkTools")
    private Mail(Builder builder) {
        this.from = builder.from;
        this.to = builder.to;
        this.subject = builder.subject;
        this.content = builder.content;
        this.mimeType = builder.mimeType;
    }

    /**
     * Creates builder to build {@link Mail}.
     * 
     * @return created builder
     */
    @Generated("SparkTools")
    public static IToStage builder() {
        return new Builder();
    }

    @Generated("SparkTools")
    public interface IToStage {
        public IFromStage withTo(String to);
    }

    @Generated("SparkTools")
    public interface IFromStage {
        public ISubjectStage withFrom(String from);
    }

    @Generated("SparkTools")
    public interface ISubjectStage {
        public IContentStage withSubject(String subject);
    }

    @Generated("SparkTools")
    public interface IContentStage {
        public IBuildStage withContent(String content);
    }

    @Generated("SparkTools")
    public interface IBuildStage {
        public IBuildStage withMimeType(String mimeType);

        public Mail build();
    }

    /**
     * Builder to build {@link Mail}.
     */
    @Generated("SparkTools")
    public static final class Builder implements IToStage, IFromStage, ISubjectStage, IContentStage, IBuildStage {
        private String to;
        private String from;
        private String subject;
        private String content;
        private String mimeType;

        private Builder() {
        }

        @Override
        public IFromStage withTo(String to) {
            this.to = to;
            return this;
        }

        @Override
        public ISubjectStage withFrom(String from) {
            this.from = from;
            return this;
        }

        @Override
        public IContentStage withSubject(String subject) {
            this.subject = subject;
            return this;
        }

        @Override
        public IBuildStage withContent(String content) {
            this.content = content;
            return this;
        }

        @Override
        public IBuildStage withMimeType(String mimeType) {
            this.mimeType = mimeType;
            return this;
        }

        @Override
        public Mail build() {
            return new Mail(this);
        }
    }

}