Lombok's @Builder not detecting fields of the Java Record

Question

I am trying to implement the builder pattern using Lombok's @Builder but it does not detect any of the record fields:

@Builder(builderMethodName = "internalBuilder")
public record ApiError(String title, Map<String, String> errors) {

    public static ApiErrorBuilder builder(String title) {
        return internalBuilder().title(title); // Cannot resolve method 'title' in 'ApiErrorBuilder'
    }
}

When I turn record to a class, everything works as expected:

@Builder(builderMethodName = "internalBuilder")
public class ApiError {

private final String title;
private final Map<String, String> errors;

    public ApiError(String title, Map<String, String> errors) {
        this.title = title;
        this.errors = errors;
    }

    public static ApiErrorBuilder builder(String title) {
        return internalBuilder().title(title);
    }

    // getters

}

Is this happening because Lombok currently does not work well with records yet?

I am using IntelliJ and Lombok 1.18.22

Circumscribe

Please try if you can use maven/gradle to build. In my case mvn clean compile is working fine and IntelliJ is having compile issue. – Horacehoracio

@Horacehoracio yeah you were right. Tried with maven and build was successful. Seems like it's an IntelliJ issue. – Circumscribe

What did you expect? They both generate code, and both are new(ish) features. One or the other has to generate its code first. Whichever one that is will not recognize the other... because the other will not yet exist at that point. The accepted answer makes a lot of sense. Most features would more or less implement themselves, and then there are wrinkles these. – Hyetography

Answer 1

Post fix

It works again!

@Builder
public record MyRecord(String myField) {
}

Pre fix

It was a known IntelliJ bug. There was, however, a workaround:

public record MyRecord(String myField) {
    @Builder public MyRecord {}
} 

Important: Once you insert the @builder inside the record, you must remove the @builder above it

Viperine

Answer 2

According to this, records are supported from Lombok version v1.18.20

@Builder on records is supported since the last release v1.18.20. Which version are you using?

Note that this may also be just an IDE issue. If you are using IntelliJ, it may not be supported, yet.

Probably an IntelliJ issue. Try writing the code without IntelliJ auto-complete, see if it compiles. If it does, it's an IntelliJ issue; if it does not, something is wrong with your code.

Nunnally

The code itself is fine as I when change the record to class everything works as expected (@Builder detects and generates methods for the fields) – Circumscribe

Just raised a ticket Unexpected compile error with @Builder on record – Horacehoracio

Answer 3

It's an IntelliJ issue. Upgrading IntelliJ version fixed this problem.

Insipience