Convert classes to records where possible.

PiperOrigin-RevId: 890973123

Author: eamonnmcmanus

core/src/main/java/com/google/googlejavaformat/Doc.java

@@ -74,19 +74,7 @@ public enum FillMode {
   public static final int MAX_LINE_WIDTH = 1000;
 
   /** State for writing. */
-  public static final class State {
-    final int lastIndent;
-    final int indent;
-    final int column;
-    final boolean mustBreak;
-
-    State(int lastIndent, int indent, int column, boolean mustBreak) {
-      this.lastIndent = lastIndent;
-      this.indent = indent;
-      this.column = column;
-      this.mustBreak = mustBreak;
-    }
-
+  public record State(int lastIndent, int indent, int column, boolean mustBreak) {
     public State(int indent0, int column0) {
       this(indent0, indent0, column0, false);
     }
@@ -98,16 +86,6 @@ State withColumn(int column) {
     State withMustBreak(boolean mustBreak) {
       return new State(lastIndent, indent, column, mustBreak);
     }
-
-    @Override
-    public String toString() {
-      return MoreObjects.toStringHelper(this)
-          .add("lastIndent", lastIndent)
-          .add("indent", indent)
-          .add("column", column)
-          .add("mustBreak", mustBreak)
-          .toString();
-    }
   }
 
   private static final Range<Integer> EMPTY_RANGE = Range.closedOpen(-1, -1);

core/src/main/java/com/google/googlejavaformat/FormatterDiagnostic.java

@@ -17,60 +17,36 @@
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 
-/** An error that prevented formatting from succeeding. */
-public class FormatterDiagnostic {
-  private final int lineNumber;
-  private final String message;
-  private final int column;
-
-  public static FormatterDiagnostic create(String message) {
-    return new FormatterDiagnostic(-1, -1, message);
-  }
-
-  public static FormatterDiagnostic create(int lineNumber, int column, String message) {
-    checkArgument(lineNumber >= 0);
-    checkArgument(column >= 0);
+/**
+ * An error that prevented formatting from succeeding.
+ *
+ * @param line the line number on which the error occurred, or {@code -1} if the error does not have
+ *     a line number.
+ * @param column the 1-indexed column number on which the error occurred, or {@code -1} if the error
+ *     does not have a column.
+ * @param message a description of the problem that prevented formatting from succeeding.
+ */
+public record FormatterDiagnostic(int line, int column, String message) {
+  public FormatterDiagnostic {
+    checkArgument(line >= -1);
+    checkArgument(column >= -1);
     checkNotNull(message);
-    return new FormatterDiagnostic(lineNumber, column, message);
-  }
-
-  private FormatterDiagnostic(int lineNumber, int column, String message) {
-    this.lineNumber = lineNumber;
-    this.column = column;
-    this.message = message;
-  }
-
-  /**
-   * Returns the line number on which the error occurred, or {@code -1} if the error does not have a
-   * line number.
-   */
-  public int line() {
-    return lineNumber;
-  }
-
-  /**
-   * Returns the 1-indexed column number on which the error occurred, or {@code -1} if the error
-   * does not have a column.
-   */
-  public int column() {
-    return column;
   }
 
-  /** Returns a description of the problem that prevented formatting from succeeding. */
-  public String message() {
-    return message;
+  public FormatterDiagnostic(String message) {
+    this(-1, -1, message);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    if (lineNumber >= 0) {
-      sb.append(lineNumber).append(':');
+    if (line >= 0) {
+      sb.append(line).append(':');
     }
     if (column >= 0) {
       sb.append(column).append(':');
     }
-    if (lineNumber >= 0 || column >= 0) {
+    if (line >= 0 || column >= 0) {
       sb.append(' ');
     }
     sb.append("error: ").append(message);

core/src/main/java/com/google/googlejavaformat/Input.java

@@ -141,7 +141,7 @@ public String toString() {
    * numbers.
    */
   public FormatterDiagnostic createDiagnostic(int inputPosition, String message) {
-    return FormatterDiagnostic.create(
+    return new FormatterDiagnostic(
         getLineNumber(inputPosition), getColumnNumber(inputPosition), message);
   }
 }

core/src/main/java/com/google/googlejavaformat/java/FormatterException.java

@@ -32,7 +32,7 @@ public final class FormatterException extends Exception {
   private final ImmutableList<FormatterDiagnostic> diagnostics;
 
   public FormatterException(String message) {
-    this(FormatterDiagnostic.create(message));
+    this(new FormatterDiagnostic(message));
   }
 
   public FormatterException(FormatterDiagnostic diagnostic) {
@@ -57,7 +57,7 @@ public static FormatterException fromJavacDiagnostics(
   }
 
   private static FormatterDiagnostic toFormatterDiagnostic(Diagnostic<?> input) {
-    return FormatterDiagnostic.create(
+    return new FormatterDiagnostic(
         (int) input.getLineNumber(), (int) input.getColumnNumber(), input.getMessage(ENGLISH));
   }
 

core/src/main/java/com/google/googlejavaformat/java/ImportOrderer.java

@@ -195,31 +195,21 @@ enum ImportType {
     NORMAL
   }
 
-  /** An import statement. */
-  class Import {
-    private final String imported;
-    private final String trailing;
-    private final ImportType importType;
-
-    Import(String imported, String trailing, ImportType importType) {
-      this.imported = imported;
-      this.trailing = trailing;
-      this.importType = importType;
-    }
-
-    /** The name being imported, for example {@code java.util.List}. */
-    String imported() {
-      return imported;
-    }
-
-    /** Returns the {@link ImportType}. */
-    ImportType importType() {
-      return importType;
-    }
-
+  /**
+   * An import statement.
+   *
+   * @param imported the name being imported, for example {@code java.util.List}.
+   * @param trailing the {@code //} comment lines after the final {@code ;}, up to and including the
+   *     line terminator of the last one. Note: In case two imports were separated by a space (which
+   *     is disallowed by the style guide), the trailing whitespace of the first import does not
+   *     include a line terminator.
+   * @param importType the {@link ImportType} of the import.
+   * @param lineSeparator the line separator to use when formatting the import.
+   */
+  record Import(String imported, String trailing, ImportType importType, String lineSeparator) {
     /** The top-level package of the import. */
     String topLevel() {
-      return DOT_SPLITTER.split(imported()).iterator().next();
+      return DOT_SPLITTER.split(imported).iterator().next();
     }
 
     /** True if this is an Android import per AOSP style. */
@@ -236,16 +226,6 @@ boolean isJava() {
       };
     }
 
-    /**
-     * The {@code //} comment lines after the final {@code ;}, up to and including the line
-     * terminator of the last one. Note: In case two imports were separated by a space (which is
-     * disallowed by the style guide), the trailing whitespace of the first import does not include
-     * a line terminator.
-     */
-    String trailing() {
-      return trailing;
-    }
-
     /** True if this is a third-party import per AOSP style. */
     public boolean isThirdParty() {
       return !(isAndroid() || isJava());
@@ -280,15 +260,7 @@ private String tokString(int start, int end) {
     return sb.toString();
   }
 
-  private static class ImportsAndIndex {
-    final ImmutableSortedSet<Import> imports;
-    final int index;
-
-    ImportsAndIndex(ImmutableSortedSet<Import> imports, int index) {
-      this.imports = imports;
-      this.index = index;
-    }
-  }
+  private record ImportsAndIndex(ImmutableSortedSet<Import> imports, int index) {}
 
   /**
    * Scans a sequence of import lines. The parsing uses this approximate grammar:
@@ -366,7 +338,7 @@ private ImportsAndIndex scanImports(int i) throws FormatterException {
         // Extra semicolons are not allowed by the JLS but are accepted by javac.
         i++;
       }
-      imports.add(new Import(importedName, trailing.toString(), importType));
+      imports.add(new Import(importedName, trailing.toString(), importType, lineSeparator));
       // Remember the position just after the import we just saw, before skipping blank lines.
       // If the next thing after the blank lines is not another import then we don't want to
       // include those blank lines in the text to be replaced.

core/src/main/java/com/google/googlejavaformat/java/JavaOutput.java

@@ -337,13 +337,13 @@ private Range<Integer> expandToBreakableRegions(Range<Integer> iRange) {
 
   public static String applyReplacements(String input, List<Replacement> replacements) {
     replacements = new ArrayList<>(replacements);
-    replacements.sort(comparing((Replacement r) -> r.getReplaceRange().lowerEndpoint()).reversed());
+    replacements.sort(comparing((Replacement r) -> r.replaceRange().lowerEndpoint()).reversed());
     StringBuilder writer = new StringBuilder(input);
     for (Replacement replacement : replacements) {
       writer.replace(
-          replacement.getReplaceRange().lowerEndpoint(),
-          replacement.getReplaceRange().upperEndpoint(),
-          replacement.getReplacementString());
+          replacement.replaceRange().lowerEndpoint(),
+          replacement.replaceRange().upperEndpoint(),
+          replacement.replacementString());
     }
     return writer.toString();
   }

core/src/main/java/com/google/googlejavaformat/java/JavacTokens.java

@@ -37,40 +37,15 @@ final class JavacTokens {
   // TODO(b/33103797): fix javac and remove the work-around
   private static final CharSequence EOF_COMMENT = "\n//EOF";
 
-  /** An unprocessed input token, including whitespace and comments. */
-  static class RawTok {
-    private final String stringVal;
-    private final TokenKind kind;
-    private final int pos;
-    private final int endPos;
-
-    RawTok(String stringVal, TokenKind kind, int pos, int endPos) {
-      this.stringVal = stringVal;
-      this.kind = kind;
-      this.pos = pos;
-      this.endPos = endPos;
-    }
-
-    /** The token kind, or {@code null} for whitespace and comments. */
-    public TokenKind kind() {
-      return kind;
-    }
-
-    /** The start position. */
-    public int pos() {
-      return pos;
-    }
-
-    /** The end position. */
-    public int endPos() {
-      return endPos;
-    }
-
-    /** The escaped string value of a literal, or {@code null} for other tokens. */
-    public String stringVal() {
-      return stringVal;
-    }
-  }
+  /**
+   * An unprocessed input token, including whitespace and comments.
+   *
+   * @param stringVal the escaped string value of a literal, or {@code null} for other tokens.
+   * @param kind the token kind, or {@code null} for whitespace and comments.
+   * @param pos the start position.
+   * @param endPos the end position.
+   */
+  record RawTok(String stringVal, TokenKind kind, int pos, int endPos) {}
 
   /** Lex the input and return a list of {@link RawTok}s. */
   public static ImmutableList<RawTok> getTokens(
@@ -94,8 +69,8 @@ public static ImmutableList<RawTok> getTokens(
             tokens.add(new RawTok(null, null, last, c.getSourcePos(0)));
           }
           tokens.add(
-              new RawTok(null, null, c.getSourcePos(0), c.getSourcePos(0) + c.getText().length()));
-          last = c.getSourcePos(0) + c.getText().length();
+              new RawTok(null, null, c.getSourcePos(0), c.getSourcePos(0) + c.text().length()));
+          last = c.getSourcePos(0) + c.text().length();
         }
       }
       if (stopTokens.contains(t.kind)) {
@@ -173,25 +148,14 @@ private char[] getRawCharactersReflectively(int beginIndex, int endIndex) {
   }
 
   /** A {@link Comment} that saves its text and start position. */
-  static class CommentWithTextAndPosition {
-
-    private final int pos;
-    private final int endPos;
-    private final String text;
-
-    public CommentWithTextAndPosition(int pos, int endPos, String text) {
-      this.pos = pos;
-      this.endPos = endPos;
-      this.text = text;
-    }
-
+  record CommentWithTextAndPosition(int pos, int endPos, String text) {
     /**
      * Returns the source position of the character at index {@code index} in the comment text.
      *
      * <p>The handling of javadoc comments in javac has more logic to skip over leading whitespace
      * and '*' characters when indexing into doc comments, but we don't need any of that.
      */
-    public int getSourcePos(int index) {
+    int getSourcePos(int index) {
       checkArgument(
           0 <= index && index < (endPos - pos),
           "Expected %s in the range [0, %s)",
@@ -200,13 +164,9 @@ public int getSourcePos(int index) {
       return pos + index;
     }
 
-    public String getText() {
-      return text;
-    }
-
     @Override
     public String toString() {
-      return String.format("Comment: '%s'", getText());
+      return String.format("Comment: '%s'", text());
     }
   }
 

core/src/main/java/com/google/googlejavaformat/java/ModifierOrderer.java

@@ -50,9 +50,8 @@ static JavaInput reorderModifiers(String text) throws FormatterException {
    * (e.g. for {@code public}), but may be multiple tokens for modifiers containing {@code -} (e.g.
    * {@code non-sealed}).
    */
-  static class ModifierTokens implements Comparable<ModifierTokens> {
-    private final ImmutableList<Token> tokens;
-    private final Modifier modifier;
+  record ModifierTokens(ImmutableList<Token> tokens, Modifier modifier)
+      implements Comparable<ModifierTokens> {
 
     static ModifierTokens create(ImmutableList<Token> tokens) {
       return new ModifierTokens(tokens, asModifier(tokens));
@@ -62,23 +61,10 @@ static ModifierTokens empty() {
       return new ModifierTokens(ImmutableList.of(), null);
     }
 
-    ModifierTokens(ImmutableList<Token> tokens, Modifier modifier) {
-      this.tokens = tokens;
-      this.modifier = modifier;
-    }
-
     boolean isEmpty() {
       return tokens.isEmpty() || modifier == null;
     }
 
-    Modifier modifier() {
-      return modifier;
-    }
-
-    ImmutableList<Token> tokens() {
-      return tokens;
-    }
-
     private Token first() {
       return tokens.get(0);
     }