Use immutable interface for return types when the actual values returned

are of an immutable collection. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=176038754
google · Nov 17, 2017 · 55e9f07 · 55e9f07
1 parent 146316b
commit 55e9f07
Show file tree

Hide file tree

Showing 25 changed files with 55 additions and 60 deletions.
diff --git a/src/com/google/javascript/jscomp/AbstractCommandLineRunner.java b/src/com/google/javascript/jscomp/AbstractCommandLineRunner.java
@@ -578,11 +578,11 @@ protected List<SourceFile> createInputs(
   }
 
   /**
-   * Check that relative paths inside zip files are unique, since multiple files
+   * Check that relative paths inside zip files are unique, since multiple files with the same path
-   * with the same path inside different zips are considered duplicate inputs.
+   * inside different zips are considered duplicate inputs. Parameter {@code sourceFiles} may be
-   * Parameter {@code sourceFiles} may be modified if duplicates are removed.
+   * modified if duplicates are removed.
    */
-  public static List<JSError> removeDuplicateZipEntries(
+  public static ImmutableList<JSError> removeDuplicateZipEntries(
       List<SourceFile> sourceFiles, List<JsModuleSpec> jsModuleSpecs) throws IOException {
     ImmutableList.Builder<JSError> errors = ImmutableList.builder();
     Map<String, SourceFile> sourceFilesByName = new HashMap<>();

diff --git a/src/com/google/javascript/jscomp/CheckMissingAndExtraRequires.java b/src/com/google/javascript/jscomp/CheckMissingAndExtraRequires.java
@@ -140,7 +140,7 @@ private static boolean isClassOrConstantName(String name) {
 
   // Return the shortest prefix of the className that refers to a class,
   // or null if no part refers to a class.
-  private static List<String> getClassNames(String qualifiedName) {
+  private static ImmutableList<String> getClassNames(String qualifiedName) {
     ImmutableList.Builder<String> classNames = ImmutableList.builder();
     List<String> parts = DOT_SPLITTER.splitToList(qualifiedName);
     for (int i = 0; i < parts.size(); i++) {

diff --git a/src/com/google/javascript/jscomp/ChromeCodingConvention.java b/src/com/google/javascript/jscomp/ChromeCodingConvention.java
@@ -15,14 +15,14 @@
  */
 package com.google.javascript.jscomp;
 
+import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.errorprone.annotations.Immutable;
 import com.google.javascript.jscomp.ClosureCodingConvention.AssertInstanceofSpec;
 import com.google.javascript.rhino.FunctionTypeI;
 import com.google.javascript.rhino.Node;
 import com.google.javascript.rhino.NominalTypeBuilder;
-import java.util.Collection;
 
 /**
  * Coding convention used by the Chrome team to compile Chrome's JS.
@@ -60,12 +60,12 @@ public void applySingletonGetter(NominalTypeBuilder classType, FunctionTypeI get
   }
 
   @Override
-  public Collection<String> getIndirectlyDeclaredProperties() {
+  public ImmutableCollection<String> getIndirectlyDeclaredProperties() {
     return indirectlyDeclaredProperties;
   }
 
   @Override
-  public Collection<AssertionFunctionSpec> getAssertionFunctions() {
+  public ImmutableCollection<AssertionFunctionSpec> getAssertionFunctions() {
     return ImmutableList.of(
       new AssertionFunctionSpec("assert"),
       new AssertInstanceofSpec("cr.ui.decorate")

diff --git a/src/com/google/javascript/jscomp/ClosureCodingConvention.java b/src/com/google/javascript/jscomp/ClosureCodingConvention.java
@@ -19,6 +19,7 @@
 import static com.google.common.base.Preconditions.checkArgument;
 
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.errorprone.annotations.Immutable;
@@ -33,7 +34,6 @@
 import com.google.javascript.rhino.jstype.JSTypeNative;
 import com.google.javascript.rhino.jstype.JSTypeRegistry;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.List;
 
 /**
@@ -388,7 +388,7 @@ public boolean isPrivate(String name) {
   }
 
   @Override
-  public Collection<AssertionFunctionSpec> getAssertionFunctions() {
+  public ImmutableCollection<AssertionFunctionSpec> getAssertionFunctions() {
     return ImmutableList.of(
         new AssertionFunctionSpec("goog.asserts.assert", JSTypeNative.TRUTHY),
         new AssertionFunctionSpec("goog.asserts.assertNumber", JSTypeNative.NUMBER_TYPE),
@@ -471,7 +471,7 @@ private boolean matchesCacheMethodName(Node target) {
   }
 
   @Override
-  public Collection<String> getIndirectlyDeclaredProperties() {
+  public ImmutableCollection<String> getIndirectlyDeclaredProperties() {
     return indirectlyDeclaredProperties;
   }
 

diff --git a/src/com/google/javascript/jscomp/CodePrinter.java b/src/com/google/javascript/jscomp/CodePrinter.java
@@ -227,7 +227,7 @@ protected final int getCurrentLineIndex() {
     }
 
     /** Calculates length of each line in compiled code. */
-    private static List<Integer> computeLineLengths(String code) {
+    private static ImmutableList<Integer> computeLineLengths(String code) {
       ImmutableList.Builder<Integer> builder = ImmutableList.<Integer>builder();
       int lineStartPos = 0;
       int lineEndPos = code.indexOf('\n');

diff --git a/src/com/google/javascript/jscomp/ConformanceRules.java b/src/com/google/javascript/jscomp/ConformanceRules.java
@@ -23,6 +23,7 @@
 import com.google.common.base.Ascii;
 import com.google.common.base.Joiner;
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMultimap;
 import com.google.common.collect.ImmutableSet;
@@ -1628,7 +1629,7 @@ protected ConformanceResult checkConformance(NodeTraversal t, Node n) {
       return ConformanceResult.CONFORMANCE;
     }
 
-    private Collection<String> getTagNames(Node tag) {
+    private ImmutableCollection<String> getTagNames(Node tag) {
       if (tag.isString()) {
         return ImmutableSet.of(tag.getString().toLowerCase());
       } else if (tag.isGetProp() && tag.getFirstChild().matchesQualifiedName("goog.dom.TagName")) {

diff --git a/src/com/google/javascript/jscomp/GlobalTypeInfoCollector.java b/src/com/google/javascript/jscomp/GlobalTypeInfoCollector.java
@@ -22,6 +22,7 @@
 
 import com.google.common.base.Preconditions;
 import com.google.common.collect.HashBasedTable;
+import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.LinkedHashMultimap;
@@ -523,8 +524,8 @@ private void defineObjectAndFunctionIfMissing() {
     }
   }
 
-  private Collection<PropertyDef> getPropDefsFromInterface(NominalType nominalType,
+  private ImmutableCollection<PropertyDef> getPropDefsFromInterface(
-      String pname) {
+      NominalType nominalType, String pname) {
     checkArgument(nominalType.isFrozen());
     checkArgument(nominalType.isInterface() || nominalType.isBuiltinObject());
     if (nominalType.getPropDeclaredType(pname) == null) {

diff --git a/src/com/google/javascript/jscomp/NTIScope.java b/src/com/google/javascript/jscomp/NTIScope.java
@@ -377,7 +377,7 @@ Set<String> getOuterVars() {
     return new LinkedHashSet<>(outerVars);
   }
 
-  Set<String> getLocalFunDefs() {
+  ImmutableSet<String> getLocalFunDefs() {
     return ImmutableSet.copyOf(localFunDefs.keySet());
   }
 
@@ -490,11 +490,11 @@ NTIScope getScope(String fnName) {
     return s;
   }
 
-  Set<String> getLocals() {
+  ImmutableSet<String> getLocals() {
     return ImmutableSet.copyOf(locals.keySet());
   }
 
-  Set<String> getExterns() {
+  ImmutableSet<String> getExterns() {
     return ImmutableSet.copyOf(externs.keySet());
   }
 

diff --git a/src/com/google/javascript/jscomp/PolymerPass.java b/src/com/google/javascript/jscomp/PolymerPass.java
@@ -22,6 +22,7 @@
 import static com.google.javascript.jscomp.PolymerPassErrors.POLYMER_MISSING_EXTERNS;
 
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback;
 import com.google.javascript.rhino.IR;
 import com.google.javascript.rhino.JSDocInfo;
@@ -30,7 +31,6 @@
 import com.google.javascript.rhino.Node;
 import com.google.javascript.rhino.Token;
 import java.util.HashSet;
-import java.util.Map;
 import java.util.Set;
 
 /**
@@ -48,7 +48,7 @@ final class PolymerPass extends AbstractPostOrderCallback implements HotSwapComp
   static final String VIRTUAL_FILE = "<PolymerPass.java>";
 
   private final AbstractCompiler compiler;
-  private final Map<String, String> tagNameMap;
+  private final ImmutableMap<String, String> tagNameMap;
   private final int polymerVersion;
   private final boolean propertyRenamingEnabled;
 

diff --git a/src/com/google/javascript/jscomp/SymbolTable.java b/src/com/google/javascript/jscomp/SymbolTable.java
@@ -147,7 +147,7 @@ public Iterable<Reference> getReferences(Symbol symbol) {
     return Collections.unmodifiableCollection(symbol.references.values());
   }
 
-  public List<Reference> getReferenceList(Symbol symbol) {
+  public ImmutableList<Reference> getReferenceList(Symbol symbol) {
     return ImmutableList.copyOf(symbol.references.values());
   }
 

diff --git a/src/com/google/javascript/jscomp/TagNameToType.java b/src/com/google/javascript/jscomp/TagNameToType.java
@@ -17,13 +17,11 @@
 
 import com.google.common.collect.ImmutableMap;
 
-import java.util.Map;
-
 /**
  * Contains a mapping from HTML Element tag name to the javascript type of that element at runtime.
  */
 class TagNameToType {
-  static Map<String, String> getMap() {
+  static ImmutableMap<String, String> getMap() {
       return new ImmutableMap.Builder<String, String>()
           .put("a", "HTMLAnchorElement")
           .put("area", "HTMLAreaElement")

diff --git a/src/com/google/javascript/jscomp/deps/Es6SortedDependencies.java b/src/com/google/javascript/jscomp/deps/Es6SortedDependencies.java
@@ -68,7 +68,7 @@ public Es6SortedDependencies(List<INPUT> userOrderedInputs) {
   }
 
   @Override
-  public List<INPUT> getDependenciesOf(List<INPUT> rootInputs, boolean sorted) {
+  public ImmutableList<INPUT> getDependenciesOf(List<INPUT> rootInputs, boolean sorted) {
     checkArgument(userOrderedInputs.containsAll(rootInputs));
 
     Set<INPUT> includedInputs = new HashSet<>();
@@ -105,7 +105,7 @@ public INPUT getInputProviding(String symbolName) throws MissingProvideException
   }
 
   @Override
-  public List<INPUT> getInputsWithoutProvides() {
+  public ImmutableList<INPUT> getInputsWithoutProvides() {
     return ImmutableList.copyOf(nonExportingInputs.values());
   }
 

diff --git a/src/com/google/javascript/jscomp/deps/SimpleDependencyInfo.java b/src/com/google/javascript/jscomp/deps/SimpleDependencyInfo.java
@@ -92,7 +92,7 @@ public ImmutableMap<String, String> getLoadFlags() {
     return loadFlags;
   }
 
-  private static Map<String, String> loadFlags(boolean isModule) {
+  private static ImmutableMap<String, String> loadFlags(boolean isModule) {
     return isModule ? ImmutableMap.of("module", "goog") : ImmutableMap.<String, String>of();
   }
 

diff --git a/src/com/google/javascript/jscomp/gwt/client/GwtRunner.java b/src/com/google/javascript/jscomp/gwt/client/GwtRunner.java
@@ -189,10 +189,8 @@ private static native String[] getStringArray(Flags flags, String key) /*-{
   private static final class JsMap extends JavaScriptObject {
     protected JsMap() {}
 
-    /**
+    /** @return This {@code JsMap} as a {@link Map}. */
-     * @return This {@code JsMap} as a {@link Map}.
+    ImmutableMap<String, Object> asMap() {
-     */
-    Map<String, Object> asMap() {
       ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<>();
       for (String key : keys(this)) {
         builder.put(key, get(key));
@@ -285,7 +283,7 @@ private static List<SourceFile> createExterns(CompilerOptions.Environment enviro
     return DefaultExterns.prepareExterns(environment, all);
   }
 
-  private static List<ModuleIdentifier> createEntryPoints(String[] entryPoints) {
+  private static ImmutableList<ModuleIdentifier> createEntryPoints(String[] entryPoints) {
     ImmutableList.Builder<ModuleIdentifier> builder = new ImmutableList.Builder<>();
     for (String entryPoint : entryPoints) {
       if (entryPoint.startsWith("goog:")) {

diff --git a/src/com/google/javascript/jscomp/parsing/ParserRunner.java b/src/com/google/javascript/jscomp/parsing/ParserRunner.java
@@ -107,7 +107,7 @@ private static synchronized void initResourceConfig() {
     reservedVars = extractList(config.getString("compiler.reserved.vars"));
   }
 
-  private static Set<String> extractList(String configProp) {
+  private static ImmutableSet<String> extractList(String configProp) {
     return ImmutableSet.copyOf(Splitter.on(',').trimResults().split(configProp));
   }
 

diff --git a/src/com/google/javascript/jscomp/regex/RegExpTree.java b/src/com/google/javascript/jscomp/regex/RegExpTree.java
@@ -590,7 +590,7 @@ public final int numCapturingGroups() {
     }
 
     @Override
-    public final List<? extends RegExpTree> children() {
+    public final ImmutableList<? extends RegExpTree> children() {
       return ImmutableList.of();
     }
   }
@@ -870,7 +870,7 @@ public int numCapturingGroups() {
     }
 
     @Override
-    public List<? extends RegExpTree> children() {
+    public ImmutableList<? extends RegExpTree> children() {
       return ImmutableList.of(body);
     }
 
@@ -1118,7 +1118,7 @@ public int numCapturingGroups() {
     }
 
     @Override
-    public List<? extends RegExpTree> children() {
+    public ImmutableList<? extends RegExpTree> children() {
       return alternatives;
     }
 
@@ -1189,7 +1189,7 @@ public int numCapturingGroups() {
     }
 
     @Override
-    public List<? extends RegExpTree> children() {
+    public ImmutableList<? extends RegExpTree> children() {
       return ImmutableList.of(body);
     }
 
@@ -1246,7 +1246,7 @@ public int numCapturingGroups() {
     }
 
     @Override
-    public List<? extends RegExpTree> children() {
+    public ImmutableList<? extends RegExpTree> children() {
       return ImmutableList.of(body);
     }
 
@@ -1746,7 +1746,7 @@ public int numCapturingGroups() {
     }
 
     @Override
-    public List<? extends RegExpTree> children() {
+    public ImmutableList<? extends RegExpTree> children() {
       return elements;
     }
 

diff --git a/src/com/google/javascript/refactoring/ApplySuggestedFixes.java b/src/com/google/javascript/refactoring/ApplySuggestedFixes.java
@@ -84,13 +84,12 @@ public static void applySuggestedFixesToFiles(Iterable<SuggestedFix> fixes)
   }
 
   /**
-   * Applies the provided set of suggested fixes to the provided code and returns the new code.
+   * Applies the provided set of suggested fixes to the provided code and returns the new code. The
-   * The {@code filenameToCodeMap} must contain all the files that the provided fixes apply to.
+   * {@code filenameToCodeMap} must contain all the files that the provided fixes apply to. The
-   * The fixes can be provided in any order, but they may not have any overlapping modifications
+   * fixes can be provided in any order, but they may not have any overlapping modifications for the
-   * for the same file.
+   * same file. This function will return new code only for the files that have been modified.
-   * This function will return new code only for the files that have been modified.
    */
-  public static Map<String, String> applySuggestedFixesToCode(
+  public static ImmutableMap<String, String> applySuggestedFixesToCode(
       Iterable<SuggestedFix> fixes, Map<String, String> filenameToCodeMap) {
     ReplacementMap map = new ReplacementMap();
     for (SuggestedFix fix : fixes) {

diff --git a/src/com/google/javascript/refactoring/ErrorToFixMapper.java b/src/com/google/javascript/refactoring/ErrorToFixMapper.java
@@ -224,7 +224,7 @@ private static SuggestedFix getFixForReferenceToShortImportByLongName(
         .build();
   }
 
-  private static List<SuggestedFix> getFixesForImplicitlyNullableJsDoc(
+  private static ImmutableList<SuggestedFix> getFixesForImplicitlyNullableJsDoc(
       JSError error, AbstractCompiler compiler) {
     SuggestedFix qmark =
         new SuggestedFix.Builder()

diff --git a/src/com/google/javascript/refactoring/RefasterJsScanner.java b/src/com/google/javascript/refactoring/RefasterJsScanner.java
@@ -130,7 +130,7 @@ public void clearTemplates() {
   }
 
   @Override
-  public List<SuggestedFix> processMatch(Match match) {
+  public ImmutableList<SuggestedFix> processMatch(Match match) {
     SuggestedFix.Builder fix = new SuggestedFix.Builder();
     // Only replace the original source with a version serialized from the AST if the after template
     // is actually different. Otherwise, we might just add churn (e.g. single quotes into double
@@ -325,7 +325,7 @@ List<String> getGoogRequiresToRemove() {
       return getGoogRequiresFromPattern(REMOVE_GOOG_REQUIRE_PATTERN);
     }
 
-    private List<String> getGoogRequiresFromPattern(Pattern pattern) {
+    private ImmutableList<String> getGoogRequiresFromPattern(Pattern pattern) {
       JSDocInfo jsDoc = NodeUtil.getBestJSDocInfo(beforeTemplate);
       if (jsDoc == null) {
         return ImmutableList.of();

diff --git a/src/com/google/javascript/refactoring/examples/GoogBindToArrow.java b/src/com/google/javascript/refactoring/examples/GoogBindToArrow.java
@@ -22,7 +22,6 @@
 import com.google.javascript.refactoring.Scanner;
 import com.google.javascript.refactoring.SuggestedFix;
 import com.google.javascript.rhino.Node;
-import java.util.List;
 
 /**
  * Replaces goog.bind(..., this) with arrow functions. The pretty-printer does not do well with
@@ -58,7 +57,7 @@ public boolean matches(Node node, NodeMetadata metadata) {
   }
 
   @Override
-  public List<SuggestedFix> processMatch(Match match) {
+  public ImmutableList<SuggestedFix> processMatch(Match match) {
     AbstractCompiler compiler = match.getMetadata().getCompiler();
     Node googBindCall = match.getNode();
     Node function = googBindCall.getFirstChild().getNext();

diff --git a/test/com/google/javascript/jscomp/CompilerTestCase.java b/test/com/google/javascript/jscomp/CompilerTestCase.java
@@ -1201,7 +1201,7 @@ protected void testInternal(
     testInternal(compiler, inputs, expected, diagnostic, postconditions);
   }
 
-  private static List<SourceFile> maybeCreateSources(String name, String srcText) {
+  private static ImmutableList<SourceFile> maybeCreateSources(String name, String srcText) {
     if (srcText != null) {
       return ImmutableList.of(SourceFile.fromCode(name, srcText));
     }

diff --git a/test/com/google/javascript/jscomp/GoldenFileComparer.java b/test/com/google/javascript/jscomp/GoldenFileComparer.java
@@ -36,7 +36,7 @@ public class GoldenFileComparer {
       "test/"
           + "com/google/javascript/jscomp/testdata/";
 
-  private static List<SourceFile> coverageExterns() {
+  private static ImmutableList<SourceFile> coverageExterns() {
     SourceFile externs = SourceFile.fromCode(
         "externs", "function Symbol() {}; var window; var self;");
       return ImmutableList.of(externs);