Use records for the formatter's plain value types

Six of the types Immutables generated in open-java-format were plain
values: State's BreakState, LevelState and TokState, Level's
SplitsBreaks, OpsBuilder's OpsOutput and InputMetadata. They are
records now. The call sites use their constructors instead of builders
and of(...) factories, and the accessors keep their names.

InputMetadata keeps @immutable, which Error Prone now checks against the
record's components instead of skipping a generated class. That needed
BlankLineWanted to say it is immutable as well, and it is: its two
subclasses hold an Optional<Boolean> and an ImmutableList<BreakTag>.

OpenOp, Break and State stay on Immutables. OpenOp and Break extend
HasUniqueId, whose per-instance id orders the formatter's persistent
collections, and a record cannot extend a class. State copies itself
through its builder in a dozen places.

The 15,747 files of the JDK 21 sources format exactly as before.

Author: abashev

open-java-format/src/main/java/com/palantir/javaformat/OpsBuilder.java

@@ -20,6 +20,7 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Multimap;
+import com.google.errorprone.annotations.Immutable;
 import com.palantir.javaformat.Indent.Const;
 import com.palantir.javaformat.Input.Tok;
 import com.palantir.javaformat.doc.Break;
@@ -35,14 +36,9 @@
 import com.palantir.javaformat.java.FormatterDiagnostic;
 import com.palantir.javaformat.java.InputMetadata;
 import com.palantir.javaformat.java.InputMetadataBuilder;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
-import org.immutables.value.Value;
 
 /** An {@code OpsBuilder} creates a list of {@link Op}s, which is turned into a {@link Doc} by {@link DocBuilder}. */
 public final class OpsBuilder {
@@ -86,6 +82,7 @@ public Integer actualStartColumn(int position) {
     }
 
     /** A request to add or remove a blank line in the output. */
+    @Immutable
     public abstract static class BlankLineWanted {
 
         /** Always emit a blank line. */
@@ -501,18 +498,7 @@ private static int getI(Input.Token token) {
 
     private static final NonBreakingSpace SPACE = NonBreakingSpace.make();
 
-    @Target(ElementType.TYPE)
-    @Retention(RetentionPolicy.SOURCE)
-    @Value.Style(overshadowImplementation = true)
-    @interface OpsOutputStyle {}
-
-    @OpsOutputStyle
-    @Value.Immutable
-    public interface OpsOutput {
-        ImmutableList<Op> ops();
-
-        InputMetadata inputMetadata();
-    }
+    public record OpsOutput(ImmutableList<Op> ops, InputMetadata inputMetadata) {}
 
     /** Build a list of {@link Op}s from the {@code OpsBuilder}. */
     public OpsOutput build() {
@@ -669,10 +655,7 @@ public OpsOutput build() {
                 afterForcedBreak = isForcedBreak(op);
             }
         }
-        return ImmutableOpsOutput.builder()
-                .ops(newOps.build())
-                .inputMetadata(inputMetadataBuilder.build())
-                .build();
+        return new OpsOutput(newOps.build(), inputMetadataBuilder.build());
     }
 
     private static boolean isNonNlsComment(Input.Tok tokAfter) {

open-java-format/src/main/java/com/palantir/javaformat/doc/Comment.java

@@ -96,7 +96,7 @@ public State computeBreaks(
         int column = lastLineStart == 0 ? state.column() + lastLineLength : lastLineLength;
         return state.withColumn(column)
                 .addNewLines(Iterators.size(Newlines.lineOffsetIterator(text)))
-                .withTokState(this, ImmutableTokState.of(text));
+                .withTokState(this, new State.TokState(text));
     }
 
     @Override

open-java-format/src/main/java/com/palantir/javaformat/doc/Level.java

@@ -36,10 +36,6 @@
 import com.palantir.javaformat.doc.Obs.ExplorationNode;
 import com.palantir.javaformat.doc.Obs.LevelNode;
 import com.palantir.javaformat.doc.StartsWithBreakVisitor.Result;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
@@ -49,7 +45,6 @@
 import java.util.stream.Collector;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.immutables.value.Value;
 
 /** A {@code Level} inside a {@link Doc}. */
 public final class Level extends Doc {
@@ -127,7 +122,7 @@ protected Range<Integer> computeRange() {
     @Override
     public State computeBreaks(CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observer) {
         return tryToFitOnOneLine(maxWidth, state, docs)
-                .map(newWidth -> state.withColumn(newWidth).withLevelState(this, ImmutableLevelState.of(true)))
+                .map(newWidth -> state.withColumn(newWidth).withLevelState(this, new State.LevelState(true)))
                 .orElseGet(() -> {
                     Obs.LevelNode childLevel = observer.newChildNode(this, state);
                     State newState =
@@ -631,19 +626,20 @@ private State tryToLayOutLevelOnOneLine(
     }
 
     private static SplitsBreaks splitByBreaks(List<Doc> docs) {
-        ImmutableSplitsBreaks.Builder builder = ImmutableSplitsBreaks.builder();
+        ImmutableList.Builder<ImmutableList<Doc>> splits = ImmutableList.builder();
+        ImmutableList.Builder<Break> breaks = ImmutableList.builder();
         ImmutableList.Builder<Doc> currentSplit = ImmutableList.builder();
         for (Doc doc : docs) {
             if (doc instanceof Break b) {
-                builder.addSplits(currentSplit.build());
+                splits.add(currentSplit.build());
                 currentSplit = ImmutableList.builder();
-                builder.addBreaks(b);
+                breaks.add(b);
             } else {
                 currentSplit.add(doc);
             }
         }
-        builder.addSplits(currentSplit.build());
-        return builder.build();
+        splits.add(currentSplit.build());
+        return new SplitsBreaks(splits.build(), breaks.build());
     }
 
     /** Compute breaks for a {@link Level} that spans multiple lines. */
@@ -837,18 +833,11 @@ public String toString() {
                 .toString();
     }
 
-    @Target(ElementType.TYPE)
-    @Retention(RetentionPolicy.SOURCE)
-    @Value.Style(overshadowImplementation = true)
-    @interface SplitsBreaksStyle {}
-
-    @SplitsBreaksStyle
-    @Value.Immutable
-    interface SplitsBreaks {
-        /** Groups of {@link Doc}s that are children of the current {@link Level}, separated by {@link Break}s. */
-        ImmutableList<ImmutableList<Doc>> splits();
-
-        /** {@link Break}s between {@link Doc}s in the current {@link Level}. */
-        ImmutableList<Break> breaks();
-    }
+    /**
+     * The children of the current {@link Level}, cut at its {@link Break}s.
+     *
+     * @param splits groups of {@link Doc}s that are children of the current level, separated by breaks
+     * @param breaks the breaks between those groups
+     */
+    record SplitsBreaks(ImmutableList<ImmutableList<Doc>> splits, ImmutableList<Break> breaks) {}
 }

open-java-format/src/main/java/com/palantir/javaformat/doc/State.java

@@ -22,13 +22,8 @@
 import com.palantir.javaformat.Indent;
 import fj.data.Set;
 import fj.data.TreeMap;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
 import java.util.Objects;
 import org.immutables.value.Value;
-import org.immutables.value.Value.Parameter;
 
 /** State for writing. */
 // Automatically suppressed to unblock enforcement in new code
@@ -95,7 +90,7 @@ public static State startingState() {
     }
 
     public BreakState getBreakState(Break brk) {
-        return breakStates().get(brk).orSome(ImmutableBreakState.of(false, -1));
+        return breakStates().get(brk).orSome(new BreakState(false, -1));
     }
 
     public boolean wasBreakTaken(BreakTag breakTag) {
@@ -163,7 +158,7 @@ State withBreak(Break brk, boolean broken) {
                     .lastIndent(indent())
                     .column(newColumn)
                     .numLines(numLines() + 1)
-                    .breakStates(breakStates().set(brk, ImmutableBreakState.of(true, newColumn)))
+                    .breakStates(breakStates().set(brk, new BreakState(true, newColumn)))
                     .build();
         } else {
             return builder.column(column() + brk.getFlat().length()).build();
@@ -249,44 +244,14 @@ public static Builder builder() {
         return new Builder();
     }
 
-    @Target(ElementType.TYPE)
-    @Retention(RetentionPolicy.SOURCE)
-    @Value.Style(overshadowImplementation = true)
-    @interface BreakStateStyle {}
+    record BreakState(boolean broken, int newIndent) {}
 
-    @BreakStateStyle
-    @Value.Immutable
-    @JsonSerialize(as = ImmutableBreakState.class)
-    interface BreakState {
-        @Parameter
-        boolean broken();
-
-        @Parameter
-        int newIndent();
-    }
-
-    @Target(ElementType.TYPE)
-    @Retention(RetentionPolicy.SOURCE)
-    @Value.Style(overshadowImplementation = true)
-    @interface LevelStateStyle {}
-
-    @LevelStateStyle
-    @Value.Immutable
-    interface LevelState {
-        /** True if the entire {@link Level} fits on one line. */
-        @Parameter
-        boolean oneLine();
-    }
-
-    @Target(ElementType.TYPE)
-    @Retention(RetentionPolicy.SOURCE)
-    @Value.Style(overshadowImplementation = true)
-    @interface TokStateStyle {}
+    /**
+     * How a {@link Level} was laid out.
+     *
+     * @param oneLine true if the entire level fits on one line
+     */
+    record LevelState(boolean oneLine) {}
 
-    @TokStateStyle
-    @Value.Immutable
-    interface TokState {
-        @Parameter
-        String text();
-    }
+    record TokState(String text) {}
 }

open-java-format/src/main/java/com/palantir/javaformat/java/InputMetadata.java

@@ -19,28 +19,16 @@
 import com.google.common.collect.ImmutableRangeSet;
 import com.google.errorprone.annotations.Immutable;
 import com.palantir.javaformat.OpsBuilder.BlankLineWanted;
-import org.immutables.value.Value;
-import org.immutables.value.Value.Default;
 
 /**
  * Records metadata about the input, namely existing blank lines that we might want to preserve, as well as what ranges
  * can be partially formatted.
+ *
+ * @param blankLines remembers preferences from the input about whether blank lines are wanted or not at a given token
+ *     index
+ * @param partialFormatRanges marks regions that can be partially formatted, used to determine the actual ranges that
+ *     will be formatted when ranges are requested
  */
-// Automatically suppressed to unblock enforcement in new code
-@SuppressWarnings("ImmutablesStyle")
 @Immutable
-@Value.Immutable
-@Value.Style(overshadowImplementation = true)
-public interface InputMetadata {
-    /** Remembers preferences from the input about whether blank lines are wanted or not at a given token index. */
-    ImmutableMap<Integer, BlankLineWanted> blankLines();
-
-    /**
-     * Marks regions that can be partially formatted, used to determine the actual ranges that will be formatted when
-     * ranges are requested.
-     */
-    @Default
-    default ImmutableRangeSet<Integer> partialFormatRanges() {
-        return ImmutableRangeSet.of();
-    }
-}
+public record InputMetadata(
+        ImmutableMap<Integer, BlankLineWanted> blankLines, ImmutableRangeSet<Integer> partialFormatRanges) {}

open-java-format/src/main/java/com/palantir/javaformat/java/InputMetadataBuilder.java

@@ -51,9 +51,6 @@ public void markForPartialFormat(Input.Token start, Input.Token end) {
     }
 
     public InputMetadata build() {
-        return ImmutableInputMetadata.builder()
-                .blankLines(ImmutableMap.copyOf(blankLines))
-                .partialFormatRanges(ImmutableRangeSet.copyOf(partialFormatRanges))
-                .build();
+        return new InputMetadata(ImmutableMap.copyOf(blankLines), ImmutableRangeSet.copyOf(partialFormatRanges));
     }
 }