Make toString(), hashCode(), equals() and friends final in AutoValue classes

Developers usually don't look at the classes that AutoValue generates,
but at the hand-written classes. If the hand-written classes implement
toString(), hashCode(), equals() etc, AutoValue doesn't override them.
To make this more clear to readers of the hand-written classes
ErrorProne suggests to make these methods final.

See https://errorprone.info/bugpattern/AutoValueFinalMethods

Enable this check at ERROR severity to prevent future occurrences.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I972e8e8f9339b811c78157abef771b8c32be079c

java/com/google/gerrit/reviewdb/client/Account.java

@@ -108,12 +108,12 @@ public final class Account {
     }
 
     @Override
-    public int compareTo(Id o) {
+    public final int compareTo(Id o) {
       return Integer.compare(id(), o.id());
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return Integer.toString(get());
     }
   }

java/com/google/gerrit/reviewdb/client/AccountGroup.java

@@ -46,12 +46,12 @@ public final class AccountGroup {
     }
 
     @Override
-    public int compareTo(NameKey o) {
+    public final int compareTo(NameKey o) {
       return name().compareTo(o.name());
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return KeyUtil.encode(get());
     }
   }
@@ -97,12 +97,12 @@ public final class AccountGroup {
     }
 
     @Override
-    public int compareTo(UUID o) {
+    public final int compareTo(UUID o) {
       return uuid().compareTo(o.uuid());
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return KeyUtil.encode(get());
     }
   }
@@ -131,7 +131,7 @@ public final class AccountGroup {
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return Integer.toString(get());
     }
   }

java/com/google/gerrit/reviewdb/client/BranchNameKey.java

@@ -36,14 +36,14 @@ public abstract class BranchNameKey implements Comparable<BranchNameKey> {
   }
 
   @Override
-  public int compareTo(BranchNameKey o) {
+  public final int compareTo(BranchNameKey o) {
     // TODO(dborowitz): Only compares branch name in order to match old StringKey behavior.
     // Consider comparing project name first.
     return branch().compareTo(o.branch());
   }
 
   @Override
-  public String toString() {
+  public final String toString() {
     return project() + "," + KeyUtil.encode(branch());
   }
 }

java/com/google/gerrit/reviewdb/client/Change.java

@@ -243,7 +243,7 @@ public final class Change {
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return Integer.toString(get());
     }
   }
@@ -285,7 +285,7 @@ public final class Change {
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return get();
     }
   }

java/com/google/gerrit/reviewdb/client/PatchSet.java

@@ -129,7 +129,7 @@ public abstract class PatchSet {
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return changeId().toString() + ',' + id();
     }
   }

java/com/google/gerrit/server/StarredChangesUtil.java

@@ -104,7 +104,7 @@ public class StarredChangesUtil {
     public abstract String label();
 
     @Override
-    public String toString() {
+    public final String toString() {
       return accountId() + SEPARATOR + label();
     }
   }

java/com/google/gerrit/server/account/ProjectWatches.java

@@ -263,7 +263,7 @@ public class ProjectWatches {
     public abstract ImmutableSet<NotifyType> notifyTypes();
 
     @Override
-    public String toString() {
+    public final String toString() {
       List<NotifyType> notifyTypes = new ArrayList<>(notifyTypes());
       StringBuilder notifyValue = new StringBuilder();
       notifyValue.append(firstNonNull(filter(), FILTER_ALL)).append(" [");

java/com/google/gerrit/server/account/externalids/ExternalId.java

@@ -193,7 +193,7 @@ public abstract class ExternalId implements Serializable {
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
       return get();
     }
 
@@ -441,7 +441,7 @@ public abstract class ExternalId implements Serializable {
    * that was loaded from Git can be equal with an external ID that was created from code.
    */
   @Override
-  public boolean equals(Object obj) {
+  public final boolean equals(Object obj) {
     if (!(obj instanceof ExternalId)) {
       return false;
     }
@@ -453,7 +453,7 @@ public abstract class ExternalId implements Serializable {
   }
 
   @Override
-  public int hashCode() {
+  public final int hashCode() {
     return Objects.hash(key(), accountId(), email(), password());
   }
 
@@ -471,7 +471,7 @@ public abstract class ExternalId implements Serializable {
    * </pre>
    */
   @Override
-  public String toString() {
+  public final String toString() {
     Config c = new Config();
     writeToConfig(c);
     return c.toText();

java/com/google/gerrit/server/change/ChangeTriplet.java

@@ -65,7 +65,7 @@ public abstract class ChangeTriplet {
   public abstract Change.Key id();
 
   @Override
-  public String toString() {
+  public final String toString() {
     return format(branch(), id());
   }
 }

java/com/google/gerrit/server/config/ConfigKey.java

@@ -34,7 +34,7 @@ public abstract class ConfigKey {
   }
 
   @Override
-  public String toString() {
+  public final String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append(section()).append(".");
     if (subsection() != null) {

java/com/google/gerrit/server/config/ScheduleConfig.java

@@ -194,7 +194,7 @@ public abstract class ScheduleConfig {
   }
 
   @Override
-  public String toString() {
+  public final String toString() {
     StringBuilder b = new StringBuilder();
     b.append(formatValue(keyInterval()));
     b.append(", ");

java/com/google/gerrit/server/permissions/SectionSortCache.java

@@ -141,7 +141,7 @@ public class SectionSortCache {
     }
 
     @Override
-    public int hashCode() {
+    public final int hashCode() {
       return cachedHashCode();
     }
   }

java/com/google/gerrit/server/restapi/change/RelatedChangesSorter.java

@@ -259,12 +259,12 @@ class RelatedChangesSorter {
     }
 
     @Override
-    public int hashCode() {
+    public final int hashCode() {
       return Objects.hash(patchSet().id(), commit());
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public final boolean equals(Object obj) {
       if (!(obj instanceof PatchSetData)) {
         return false;
       }

java/com/google/gerrit/server/util/LabelVote.java

@@ -85,7 +85,7 @@ public abstract class LabelVote {
   }
 
   @Override
-  public String toString() {
+  public final String toString() {
     return format();
   }
 }

tools/BUILD

@@ -32,6 +32,7 @@ java_package_configuration(
     javacopts = [
         "-XepDisableWarningsInGeneratedCode",
         "-Xep:AmbiguousMethodReference:ERROR",
+        "-Xep:AutoValueFinalMethods:ERROR",
         "-Xep:BadAnnotationImplementation:ERROR",
         "-Xep:BadComparable:ERROR",
         "-Xep:BoxedPrimitiveConstructor:ERROR",