CompletionSuggestion API for arg list text ranges.

pkg/analysis_server/tool/spec/generated/java/types/CompletionSuggestion.java

 /*
  * Copyright (c) 2015, the Dart project authors.
  *
  * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
  *
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
@@ skipping 89 matching lines @@
    * element is not a member of a class.
    */
   private final String declaringType;
 
   /**
    * A default String for use in generating argument list source contents on the client side.
    */
   private final String defaultArgumentListString;
 
   /**
+   * Pairs of offsets and lengths describing 'defaultArgumentListString' text ranges suitable for use
+   * by clients to set up linked edits of default argument source contents. For example, given an
+   * argument list string 'x, y', the corresponding text range [0, 1, 3, 1], indicates two text
+   * ranges of length 1, starting at offsets 0 and 3. Clients can use these ranges to treat the 'x'
+   * and 'y' values specially for linked edits.
+   */
+  private final int[] defaultArgumentListTextRanges;
+
+  /**
    * Information about the element reference being suggested.
    */
   private final Element element;
 
   /**
    * The return type of the getter, function or method or the type of the field being suggested. This
    * field is omitted if the suggested element is not a getter, function or method.
    */
   private final String returnType;
 
@@ skipping 35 matching lines @@
 
   /**
    * The import to be added if the suggestion is out of scope and needs an import to be added to be
    * in scope.
    */
   private final String importUri;
 
   /**
    * Constructor for {@link CompletionSuggestion}.
    */
-  public CompletionSuggestion(String kind, int relevance, String completion, int selectionOffset, int selectionLength, boolean isDeprecated, boolean isPotential, String docSummary, String docComplete, String declaringType, String defaultArgumentListString, Element element, String returnType, List<String> parameterNames, List<String> parameterTypes, Integer requiredParameterCount, Boolean hasNamedParameters, String parameterName, String parameterType, String importUri) {
+  public CompletionSuggestion(String kind, int relevance, String completion, int selectionOffset, int selectionLength, boolean isDeprecated, boolean isPotential, String docSummary, String docComplete, String declaringType, String defaultArgumentListString, int[] defaultArgumentListTextRanges, Element element, String returnType, List<String> parameterNames, List<String> parameterTypes, Integer requiredParameterCount, Boolean hasNamedParameters, String parameterName, String parameterType, String importUri) {
     this.kind = kind;
     this.relevance = relevance;
     this.completion = completion;
     this.selectionOffset = selectionOffset;
     this.selectionLength = selectionLength;
     this.isDeprecated = isDeprecated;
     this.isPotential = isPotential;
     this.docSummary = docSummary;
     this.docComplete = docComplete;
     this.declaringType = declaringType;
     this.defaultArgumentListString = defaultArgumentListString;
+    this.defaultArgumentListTextRanges = defaultArgumentListTextRanges;
     this.element = element;
     this.returnType = returnType;
     this.parameterNames = parameterNames;
     this.parameterTypes = parameterTypes;
     this.requiredParameterCount = requiredParameterCount;
     this.hasNamedParameters = hasNamedParameters;
     this.parameterName = parameterName;
     this.parameterType = parameterType;
     this.importUri = importUri;
   }
 
   @Override
   public boolean equals(Object obj) {
     if (obj instanceof CompletionSuggestion) {
       CompletionSuggestion other = (CompletionSuggestion) obj;
       return
         ObjectUtilities.equals(other.kind, kind) &&
         other.relevance == relevance &&
         ObjectUtilities.equals(other.completion, completion) &&
         other.selectionOffset == selectionOffset &&
         other.selectionLength == selectionLength &&
         other.isDeprecated == isDeprecated &&
         other.isPotential == isPotential &&
         ObjectUtilities.equals(other.docSummary, docSummary) &&
         ObjectUtilities.equals(other.docComplete, docComplete) &&
         ObjectUtilities.equals(other.declaringType, declaringType) &&
         ObjectUtilities.equals(other.defaultArgumentListString, defaultArgumentListString) &&
+        Arrays.equals(other.defaultArgumentListTextRanges, defaultArgumentListTextRanges) &&
         ObjectUtilities.equals(other.element, element) &&
         ObjectUtilities.equals(other.returnType, returnType) &&
         ObjectUtilities.equals(other.parameterNames, parameterNames) &&
         ObjectUtilities.equals(other.parameterTypes, parameterTypes) &&
         ObjectUtilities.equals(other.requiredParameterCount, requiredParameterCount) &&
         ObjectUtilities.equals(other.hasNamedParameters, hasNamedParameters) &&
         ObjectUtilities.equals(other.parameterName, parameterName) &&
         ObjectUtilities.equals(other.parameterType, parameterType) &&
         ObjectUtilities.equals(other.importUri, importUri);
     }
     return false;
   }
 
   public static CompletionSuggestion fromJson(JsonObject jsonObject) {
     String kind = jsonObject.get("kind").getAsString();
     int relevance = jsonObject.get("relevance").getAsInt();
     String completion = jsonObject.get("completion").getAsString();
     int selectionOffset = jsonObject.get("selectionOffset").getAsInt();
     int selectionLength = jsonObject.get("selectionLength").getAsInt();
     boolean isDeprecated = jsonObject.get("isDeprecated").getAsBoolean();
     boolean isPotential = jsonObject.get("isPotential").getAsBoolean();
     String docSummary = jsonObject.get("docSummary") == null ? null : jsonObject.get("docSummary").getAsString();
     String docComplete = jsonObject.get("docComplete") == null ? null : jsonObject.get("docComplete").getAsString();
     String declaringType = jsonObject.get("declaringType") == null ? null : jsonObject.get("declaringType").getAsString();
     String defaultArgumentListString = jsonObject.get("defaultArgumentListString") == null ? null : jsonObject.get("defaultArgumentListString").getAsString();
+    int[] defaultArgumentListTextRanges = jsonObject.get("defaultArgumentListTextRanges") == null ? null : JsonUtilities.decodeIntArray(jsonObject.get("defaultArgumentListTextRanges").getAsJsonArray());
     Element element = jsonObject.get("element") == null ? null : Element.fromJson(jsonObject.get("element").getAsJsonObject());
     String returnType = jsonObject.get("returnType") == null ? null : jsonObject.get("returnType").getAsString();
     List<String> parameterNames = jsonObject.get("parameterNames") == null ? null : JsonUtilities.decodeStringList(jsonObject.get("parameterNames").getAsJsonArray());
     List<String> parameterTypes = jsonObject.get("parameterTypes") == null ? null : JsonUtilities.decodeStringList(jsonObject.get("parameterTypes").getAsJsonArray());
     Integer requiredParameterCount = jsonObject.get("requiredParameterCount") == null ? null : jsonObject.get("requiredParameterCount").getAsInt();
     Boolean hasNamedParameters = jsonObject.get("hasNamedParameters") == null ? null : jsonObject.get("hasNamedParameters").getAsBoolean();
     String parameterName = jsonObject.get("parameterName") == null ? null : jsonObject.get("parameterName").getAsString();
     String parameterType = jsonObject.get("parameterType") == null ? null : jsonObject.get("parameterType").getAsString();
     String importUri = jsonObject.get("importUri") == null ? null : jsonObject.get("importUri").getAsString();
-    return new CompletionSuggestion(kind, relevance, completion, selectionOffset, selectionLength, isDeprecated, isPotential, docSummary, docComplete, declaringType, defaultArgumentListString, element, returnType, parameterNames, parameterTypes, requiredParameterCount, hasNamedParameters, parameterName, parameterType, importUri);
+    return new CompletionSuggestion(kind, relevance, completion, selectionOffset, selectionLength, isDeprecated, isPotential, docSummary, docComplete, declaringType, defaultArgumentListString, defaultArgumentListTextRanges, element, returnType, parameterNames, parameterTypes, requiredParameterCount, hasNamedParameters, parameterName, parameterType, importUri);
   }
 
   public static List<CompletionSuggestion> fromJsonArray(JsonArray jsonArray) {
     if (jsonArray == null) {
       return EMPTY_LIST;
     }
     ArrayList<CompletionSuggestion> list = new ArrayList<CompletionSuggestion>(jsonArray.size());
     Iterator<JsonElement> iterator = jsonArray.iterator();
     while (iterator.hasNext()) {
       list.add(fromJson(iterator.next().getAsJsonObject()));
@@ skipping 19 matching lines @@
   }
 
   /**
    * A default String for use in generating argument list source contents on the client side.
    */
   public String getDefaultArgumentListString() {
     return defaultArgumentListString;
   }
 
   /**
+   * Pairs of offsets and lengths describing 'defaultArgumentListString' text ranges suitable for use
+   * by clients to set up linked edits of default argument source contents. For example, given an
+   * argument list string 'x, y', the corresponding text range [0, 1, 3, 1], indicates two text
+   * ranges of length 1, starting at offsets 0 and 3. Clients can use these ranges to treat the 'x'
+   * and 'y' values specially for linked edits.
+   */
+  public int[] getDefaultArgumentListTextRanges() {
+    return defaultArgumentListTextRanges;
+  }
+
+  /**
    * The Dartdoc associated with the element being suggested, This field is omitted if there is no
    * Dartdoc associated with the element.
    */
   public String getDocComplete() {
     return docComplete;
   }
 
   /**
    * An abbreviated version of the Dartdoc associated with the element being suggested, This field is
    * omitted if there is no Dartdoc associated with the element.
@@ skipping 124 matching lines @@
     builder.append(relevance);
     builder.append(completion);
     builder.append(selectionOffset);
     builder.append(selectionLength);
     builder.append(isDeprecated);
     builder.append(isPotential);
     builder.append(docSummary);
     builder.append(docComplete);
     builder.append(declaringType);
     builder.append(defaultArgumentListString);
+    builder.append(defaultArgumentListTextRanges);
     builder.append(element);
     builder.append(returnType);
     builder.append(parameterNames);
     builder.append(parameterTypes);
     builder.append(requiredParameterCount);
     builder.append(hasNamedParameters);
     builder.append(parameterName);
     builder.append(parameterType);
     builder.append(importUri);
     return builder.toHashCode();
@@ skipping 13 matching lines @@
     }
     if (docComplete != null) {
       jsonObject.addProperty("docComplete", docComplete);
     }
     if (declaringType != null) {
       jsonObject.addProperty("declaringType", declaringType);
     }
     if (defaultArgumentListString != null) {
       jsonObject.addProperty("defaultArgumentListString", defaultArgumentListString);
     }
+    if (defaultArgumentListTextRanges != null) {
+      JsonArray jsonArrayDefaultArgumentListTextRanges = new JsonArray();
+      for (int elt : defaultArgumentListTextRanges) {
+        jsonArrayDefaultArgumentListTextRanges.add(new JsonPrimitive(elt));
+      }
+      jsonObject.add("defaultArgumentListTextRanges", jsonArrayDefaultArgumentListTextRanges);
+    }
     if (element != null) {
       jsonObject.add("element", element.toJson());
     }
     if (returnType != null) {
       jsonObject.addProperty("returnType", returnType);
     }
     if (parameterNames != null) {
       JsonArray jsonArrayParameterNames = new JsonArray();
       for (String elt : parameterNames) {
         jsonArrayParameterNames.add(new JsonPrimitive(elt));
@@ skipping 44 matching lines @@
     builder.append("isPotential=");
     builder.append(isPotential + ", ");
     builder.append("docSummary=");
     builder.append(docSummary + ", ");
     builder.append("docComplete=");
     builder.append(docComplete + ", ");
     builder.append("declaringType=");
     builder.append(declaringType + ", ");
     builder.append("defaultArgumentListString=");
     builder.append(defaultArgumentListString + ", ");
+    builder.append("defaultArgumentListTextRanges=");
+    builder.append(StringUtils.join(defaultArgumentListTextRanges, ", ") + ", ");
     builder.append("element=");
     builder.append(element + ", ");
     builder.append("returnType=");
     builder.append(returnType + ", ");
     builder.append("parameterNames=");
     builder.append(StringUtils.join(parameterNames, ", ") + ", ");
     builder.append("parameterTypes=");
     builder.append(StringUtils.join(parameterTypes, ", ") + ", ");
     builder.append("requiredParameterCount=");
     builder.append(requiredParameterCount + ", ");
     builder.append("hasNamedParameters=");
     builder.append(hasNamedParameters + ", ");
     builder.append("parameterName=");
     builder.append(parameterName + ", ");
     builder.append("parameterType=");
     builder.append(parameterType + ", ");
     builder.append("importUri=");
     builder.append(importUri);
     builder.append("]");
     return builder.toString();
   }
 
 }