Annotate rhino_ast APIs with @CanIgnoreReturnValue as appropriate.

PiperOrigin-RevId: 848259924

Author: kluever

src/com/google/javascript/rhino/JSDocInfo.java

@@ -1640,6 +1640,7 @@ private static Builder copyFromAndReplaceNames(JSDocInfo info, Set<String> oldNa
      * instantiating the builder if documentation should be included, since it enables various
      * operations to do work that would otherwise be no-ops.
      */
+    @CanIgnoreReturnValue
     public Builder parseDocumentation() {
       setBit(Bit.INCLUDE_DOCUMENTATION, true);
       return this;

src/com/google/javascript/rhino/jstype/EnumType.java

@@ -42,6 +42,7 @@
 import static com.google.javascript.jscomp.base.Tri.FALSE;
 import static com.google.javascript.jscomp.base.Tri.TRUE;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.jscomp.base.Tri;
 import com.google.javascript.rhino.ErrorReporter;
 import com.google.javascript.rhino.Node;
@@ -90,18 +91,21 @@ public Builder setName(String x) {
     }
 
     /** The object literal that creates the enum, a reference to another enum, or null. */
+    @CanIgnoreReturnValue
     public Builder setSource(Node x) {
       this.source = x;
       return this;
     }
 
     /** The ID of the goog.module in which this enum was declared. */
+    @CanIgnoreReturnValue
     public Builder setGoogModuleId(String x) {
       this.googModuleId = x;
       return this;
     }
 
     /** The base type of the individual elements. */
+    @CanIgnoreReturnValue
     public Builder setElementType(JSType x) {
       this.elementType = x;
       return this;

src/com/google/javascript/rhino/jstype/EqualityChecker.java

@@ -44,6 +44,7 @@
 import static com.google.javascript.jscomp.base.JSCompObjects.identical;
 
 import com.google.common.collect.ImmutableList;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.jstype.FunctionType.Parameter;
 import com.google.javascript.rhino.jstype.JSType.MatchStatus;
 import java.util.LinkedHashMap;
@@ -104,6 +105,7 @@ enum EqMethod {
   private int recursionDepth = 0;
   private boolean hasRun = false;
 
+  @CanIgnoreReturnValue
   EqualityChecker setEqMethod(EqMethod x) {
     this.checkHasNotRun();
     checkState(this.eqMethod == null);

src/com/google/javascript/rhino/jstype/InstanceObjectType.java

@@ -42,6 +42,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.common.collect.ImmutableList;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.Node;
 
 /** An object type that is an instance of some function constructor. */
@@ -64,6 +65,7 @@ static final class Builder extends PrototypeObjectType.Builder<Builder> {
       super(registry);
     }
 
+    @CanIgnoreReturnValue
     Builder setConstructor(FunctionType x) {
       this.constructor = x;
       return this;

src/com/google/javascript/rhino/jstype/PrototypeObjectType.java

@@ -44,6 +44,7 @@
 import static com.google.javascript.jscomp.base.JSCompObjects.identical;
 
 import com.google.common.collect.ImmutableList;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.ErrorReporter;
 import com.google.javascript.rhino.JSDocInfo;
 import com.google.javascript.rhino.Node;
@@ -147,37 +148,44 @@ static class Builder<T extends Builder<T>> {
       this.templateTypeMap = registry.getEmptyTemplateTypeMap();
     }
 
+    @CanIgnoreReturnValue
     T setName(String x) {
       this.className = x;
       return castThis();
     }
 
+    @CanIgnoreReturnValue
     final T setImplicitPrototype(ObjectType x) {
       this.implicitPrototype = x;
       return castThis();
     }
 
+    @CanIgnoreReturnValue
     final T setNative(boolean x) {
       this.nativeType = x;
       return castThis();
     }
 
+    @CanIgnoreReturnValue
     final T setAnonymous(boolean x) {
       this.anonymousType = x;
       return castThis();
     }
 
+    @CanIgnoreReturnValue
     final T setTemplateTypeMap(TemplateTypeMap x) {
       this.templateTypeMap = x;
       return castThis();
     }
 
+    @CanIgnoreReturnValue
     final T setTemplateParamCount(int x) {
       this.templateParamCount = x;
       return castThis();
     }
 
     @SuppressWarnings("unchecked")
+    @CanIgnoreReturnValue
     final T castThis() {
       return (T) this;
     }

src/com/google/javascript/rhino/jstype/RecordTypeBuilder.java

@@ -40,6 +40,7 @@
 package com.google.javascript.rhino.jstype;
 
 import com.google.common.collect.ImmutableSortedMap;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.Node;
 import java.util.LinkedHashMap;
 
@@ -71,6 +72,7 @@ void setSynthesized(boolean synthesized) {
    * @param propertyNode the node that holds this property definition
    * @return The builder itself for chaining purposes.
    */
+  @CanIgnoreReturnValue
   public RecordTypeBuilder addProperty(String name, JSType type, Node propertyNode) {
     isEmpty = false;
     properties.put(name, new RecordProperty(type, propertyNode));

src/com/google/javascript/rhino/jstype/SubtypeChecker.java

@@ -46,6 +46,7 @@
 import static com.google.javascript.rhino.jstype.JSTypeIterations.anyTypeMatches;
 
 import com.google.common.collect.ImmutableSet;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.jstype.JSType.MatchStatus;
 import com.google.javascript.rhino.jstype.JSType.SubtypingMode;
 import java.util.Iterator;
@@ -89,27 +90,31 @@ final class SubtypeChecker {
   private boolean hasRun = false;
   private int recursionDepth = 0;
 
+  @CanIgnoreReturnValue
   SubtypeChecker setSupertype(JSType value) {
     checkHasNotRun();
     checkState(this.initialSupertype == null);
     this.initialSupertype = checkNotNull(value);
     return this;
   }
 
+  @CanIgnoreReturnValue
   SubtypeChecker setSubtype(JSType value) {
     checkHasNotRun();
     checkState(this.initialSubtype == null);
     this.initialSubtype = checkNotNull(value);
     return this;
   }
 
+  @CanIgnoreReturnValue
   SubtypeChecker setUsingStructuralSubtyping(boolean value) {
     checkHasNotRun();
     checkState(this.isUsingStructuralTyping == null);
     this.isUsingStructuralTyping = value;
     return this;
   }
 
+  @CanIgnoreReturnValue
   SubtypeChecker setSubtypingMode(SubtypingMode value) {
     checkHasNotRun();
     checkState(this.subtypingMode == null);

src/com/google/javascript/rhino/jstype/TypeStringBuilder.java

@@ -39,6 +39,8 @@
 
 package com.google.javascript.rhino.jstype;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
+
 /**
  * Visits types to assemble an associated stringification.
  *
@@ -58,16 +60,19 @@ boolean isForAnnotations() {
     return this.isForAnnotations;
   }
 
+  @CanIgnoreReturnValue
   TypeStringBuilder append(String x) {
     this.builder.append(x);
     return this;
   }
 
+  @CanIgnoreReturnValue
   TypeStringBuilder append(JSType x) {
     x.appendTo(this);
     return this;
   }
 
+  @CanIgnoreReturnValue
   TypeStringBuilder appendAll(Iterable<?> elements, String separator) {
     boolean separate = false;
     for (Object e : elements) {
@@ -87,7 +92,7 @@ TypeStringBuilder appendAll(Iterable<?> elements, String separator) {
     return this;
   }
 
-
+  @CanIgnoreReturnValue
   TypeStringBuilder appendNonNull(JSType type) {
     if (this.isForAnnotations
         && type.isObject()
@@ -102,11 +107,13 @@ TypeStringBuilder appendNonNull(JSType type) {
     return this.append(type);
   }
 
+  @CanIgnoreReturnValue
   TypeStringBuilder breakLineAndIndent() {
     this.builder.append("\n").append(this.indentation);
     return this;
   }
 
+  @CanIgnoreReturnValue
   TypeStringBuilder indent(Runnable cb) {
     String lastIndent = this.indentation;
     this.indentation = lastIndent + "  ";

src/com/google/javascript/rhino/testing/TestErrorReporter.java

@@ -41,6 +41,7 @@
 
 import static com.google.common.truth.Truth.assertThat;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.javascript.rhino.ErrorReporter;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -68,11 +69,13 @@ public void warning(String message, String sourceName, int line, int lineOffset)
     seenWarnings.put(fmtDiagnosticKey(message, sourceName, line, lineOffset), message);
   }
 
+  @CanIgnoreReturnValue
   public TestErrorReporter expectAllErrors(String... errors) {
     Collections.addAll(this.expectedErrors, errors);
     return this;
   }
 
+  @CanIgnoreReturnValue
   public TestErrorReporter expectAllWarnings(String... warnings) {
     Collections.addAll(this.expectedWarnings, warnings);
     return this;

src/com/google/javascript/rhino/testing/TypeSubject.java

@@ -48,6 +48,7 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.truth.FailureMetadata;
 import com.google.common.truth.Subject;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.errorprone.annotations.CheckReturnValue;
 import com.google.javascript.rhino.ClosurePrimitive;
 import com.google.javascript.rhino.jstype.FunctionType;
@@ -151,6 +152,7 @@ public FunctionTypeSubject isFunctionTypeThat() {
     return new FunctionTypeSubject();
   }
 
+  @CanIgnoreReturnValue
   public TypeSubject isObjectTypeWithProperty(String propName) {
     isLiteralObject();
     withTypeOfProp(propName).isNotNull();