Should I use RecordBuilder or Lombok for Java records?

RecordBuilder is specifically designed for Java records and generates code at compile-time with no runtime dependencies, focusing on builders and withers. Lombok is a broader tool that modifies the AST and includes runtime aspects for regular classes. Choose RecordBuilder for lightweight, record-specific enhancements, and Lombok if you need features beyond records like getters/setters.

How to set up RecordBuilder in IntelliJ IDEA?

Enable annotation processing in IntelliJ by going to Build, Execution, Deployment > Compiler > Annotation Processors and checking 'Enable annotation processing'. Also, ensure your Maven or Gradle configuration includes the record-builder-processor dependency as described in the Usage section, otherwise the generated code won't appear.

Can RecordBuilder generate builders for records in external libraries?

Yes, using the `@RecordBuilder.Include` annotation, you can specify classes from libraries to generate builders for, as shown in the Generation Via Includes section. This allows enhancing third-party records without modifying their source code, making it ideal for legacy or closed-source dependencies.

What are the limitations when generating records from interfaces?

Interface methods must have no arguments, return a value, and cannot have type parameters, as noted in the RecordInterface Example. Additionally, default methods are included in generation unless annotated with `@IgnoreDefaultMethod`, which might require careful design to avoid unintended behavior.

Is RecordBuilder compatible with Java 21 or 24?

Yes, the project badges show CI builds for Java 17, 21, and 24, and it's built for Java 16+ records, so it should work seamlessly with recent JDK releases. Always check the Maven Central version for the latest compatibility updates.

How do I customize RecordBuilder to use immutable collections?

Customization options are detailed in the customizing.md file, where you can configure RecordBuilder via annotations or properties to add immutable collections, create custom annotations, or adjust generation patterns to fit your project's data handling needs.

Record-Builder — Java Record Builder Generator

What is Record-Builder?

RecordBuilder is a Java annotation processor that generates builder classes and 'wither' copy methods for Java records. It solves the problem of Java records lacking convenient construction and modification patterns, providing a fluent API for creating and transforming immutable data objects. The tool can also generate complete records from interface definitions, making it easier to define data contracts.

Target Audience

Java developers using Java 16+ records who need more flexible construction patterns, immutable updates, or want to generate records from interfaces. It's particularly useful for projects emphasizing immutable data models and clean API design.

Value Proposition

Developers choose RecordBuilder because it seamlessly integrates with Java's standard record feature, requires no runtime dependencies, and offers extensive customization. It provides a lightweight, annotation-driven solution to overcome the limitations of vanilla records, making immutable data handling more practical and expressive.

Record builder generator for Java records

Use Cases

Best For

Adding fluent builders to Java records for step-by-step object construction
Implementing immutable updates via 'wither' methods in record-based models
Generating records and their builders from interface definitions
Enhancing library or third-party records with builders without modifying source code
Creating deconstructor-based records from existing class structures
Customizing record builder generation with project-specific patterns or collections

Not Ideal For

Projects not using Java 16+ or records at all, as it's specifically designed for that feature set
Teams prioritizing zero-configuration tools, since it requires annotation processor setup in build tools and IDEs
Applications where minimizing generated code is critical, as it adds companion classes for every record

Pros & Cons

Pros

Fluent Builder Generation

Automatically creates a fluent builder class for any Java record, enabling step-by-step construction as shown in the RecordBuilder Example with methods like `.name(aName).age(anAge).build()`.

Immutable Wither Methods

Adds `withX()` copy methods for immutable updates, either by implementing a generated interface or via static helpers, as demonstrated in the Wither Example with `r1.withName("bar")`.

Interface-to-Record Generation

Generates full records from interface definitions, including builders and withers, useful for defining data contracts without boilerplate, as in the RecordInterface Example.

External Code Support

Can generate builders for existing records and interfaces from unmodifiable source code using `@Include` annotations, allowing enhancement of library classes without modification.

Cons

Annotation Processor Setup

Requires explicit configuration in Maven, Gradle, and IDE settings for annotation processing, which can be complex and prone to environment-specific issues, as detailed in the Usage section.

Documentation Fragmentation

Key features and customization options are split across multiple markdown files (customizing.md, options.md, deconstructors.md), making it harder to find comprehensive information in one place.

IDE Dependence

Successful use depends on proper IDE configuration for annotation processing, which might not work out-of-the-box in all environments, potentially causing frustration during setup.

Frequently Asked Questions

What is Record-Builder?

Target Audience

Value Proposition

Use Cases

Best For

Adding fluent builders to Java records for step-by-step object construction
Implementing immutable updates via 'wither' methods in record-based models
Generating records and their builders from interface definitions
Enhancing library or third-party records with builders without modifying source code
Creating deconstructor-based records from existing class structures
Customizing record builder generation with project-specific patterns or collections

Not Ideal For

Projects not using Java 16+ or records at all, as it's specifically designed for that feature set
Teams prioritizing zero-configuration tools, since it requires annotation processor setup in build tools and IDEs
Applications where minimizing generated code is critical, as it adds companion classes for every record

Pros & Cons

Pros

Fluent Builder Generation

Automatically creates a fluent builder class for any Java record, enabling step-by-step construction as shown in the RecordBuilder Example with methods like `.name(aName).age(anAge).build()`.

Immutable Wither Methods

Adds `withX()` copy methods for immutable updates, either by implementing a generated interface or via static helpers, as demonstrated in the Wither Example with `r1.withName("bar")`.

Interface-to-Record Generation

Generates full records from interface definitions, including builders and withers, useful for defining data contracts without boilerplate, as in the RecordInterface Example.

External Code Support

Can generate builders for existing records and interfaces from unmodifiable source code using `@Include` annotations, allowing enhancement of library classes without modification.

Cons

Annotation Processor Setup

Requires explicit configuration in Maven, Gradle, and IDE settings for annotation processing, which can be complex and prone to environment-specific issues, as detailed in the Usage section.

Documentation Fragmentation

Key features and customization options are split across multiple markdown files (customizing.md, options.md, deconstructors.md), making it harder to find comprehensive information in one place.

IDE Dependence

Successful use depends on proper IDE configuration for annotation processing, which might not work out-of-the-box in all environments, potentially causing frustration during setup.

Frequently Asked Questions

Record-Builder

What is Record-Builder?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Record-Builder

What is Record-Builder?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?