Address review feedback.

Signed-off-by: Yaohai Zheng <[email protected]>

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/Protocol.xtend

@@ -57,7 +57,10 @@ class WorkspaceEditCapabilities {
 	/**
 	 * The client supports resource changes
 	 * in `WorkspaceEdit`s.
+	 * 
+	 * @deprecated Since LSP introduces resource operations, use {link #resourceOperations} 
 	 */
+	@Deprecated
 	@Beta Boolean resourceChanges
 
 	/**
@@ -75,6 +78,7 @@ class WorkspaceEditCapabilities {
     new() {
     }
 
+    @Deprecated
     new(Boolean documentChanges) {
     	this.documentChanges = documentChanges
     }
@@ -685,12 +689,24 @@ class ColorProviderCapabilities extends DynamicRegistrationCapabilities {
  */
 @JsonRpcData
 class RenameCapabilities extends DynamicRegistrationCapabilities {
+
+	/**
+	 * Client supports testing for validity of rename operations
+	 * before execution.
+	 */
+	Boolean prepareSupport
+
     new() {
     }
 
     new(Boolean dynamicRegistration) {
     	super(dynamicRegistration)
     }
+
+    new(Boolean prepareSupport, Boolean dynamicRegistration) {
+    	super(dynamicRegistration)
+    	this.prepareSupport = prepareSupport
+    }
 }
 
 /**
@@ -1821,6 +1837,17 @@ class SaveOptions {
     }
 }
 
+/**
+ * Rename options
+ */
+@JsonRpcData
+class RenameOptions extends StaticRegistrationOptions {
+	/**
+	 * Renames should be checked and tested before being executed.
+	 */
+	Boolean prepareProvider;
+}
+
 /**
  * Color provider Options
  */
@@ -2535,11 +2562,14 @@ class ReferenceParams extends TextDocumentPositionParams {
 @JsonRpcData
 class PrepareRenameResult {
 	/**
-	 * The capabilities the language server provides.
+	 * The range of the string to rename
 	 */
 	@NonNull
 	Range range
 
+	/*
+	 * A placeholder text of the string content to be renamed.
+	 */
 	@NonNull
 	String placeholder
 
@@ -2586,24 +2616,6 @@ class RenameParams {
     }
 }
 
-/**
- * Rename options
- */
-@JsonRpcData
-class RenameOptions {
-	/**
-	 * Renames should be checked and tested before being executed.
-	 */
-	Boolean prepareProvider;
-
-	new() {
-	}
-
-	new(Boolean prepareProvider) {
-		this.prepareProvider = prepareProvider
-	}
-}
-
 @JsonRpcData
 class ServerCapabilities {
 	/**
@@ -3315,7 +3327,7 @@ class TextDocumentEdit {
 
 @JsonRpcData
 @JsonAdapter(ResourceOperationTypeAdapter)
-class ResourceOperation {
+abstract class ResourceOperation {
 
 	@NonNull
 	String kind;
@@ -3506,9 +3518,12 @@ class DeleteFile extends ResourceOperation {
  * If both current and newUri has valid values this is considered to be a move operation.
  * If current has a valid value while newUri is null it is treated as a delete operation.
  * If current is null and newUri has a valid value a create operation is executed.
+ * 
+ * @deprecated As LSP introduces resource operation, use the {@link ResourceOperation} instead.
  */
 @JsonRpcData
 @Beta
+@Deprecated
 class ResourceChange {
 
   /**
@@ -3556,9 +3571,12 @@ class WorkspaceEdit {
 	 * rename, move, delete or content change.
 	 * These changes are applied in the order that they are supplied,
 	 * however clients may group the changes for optimization
+	 * 
+	 * @deprecated Since LSP introduces resource operations, use the {@link #documentChanges} instead
 	 */
 	@Beta
 	@JsonAdapter(ResourceChangeListAdapter)
+	@Deprecated
 	List<Either<ResourceChange, TextDocumentEdit>> resourceChanges
 
     new() {
@@ -3573,16 +3591,6 @@ class WorkspaceEdit {
 	new(List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) {
 		this.documentChanges = documentChanges
 	}
-
-	/**
-	 * @deprecated According to the protocol documentation, it doesn't make sense to send both
-	 * 		changes and documentChanges
-	 */
-	@Deprecated
-	new(Map<String, List<TextEdit>> changes, List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) {
-		this.changes = changes
-		this.documentChanges = documentChanges
-	}
 }
 
 /**

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/adapters/PrepareRenameResponseAdapter.java

@@ -0,0 +1,45 @@
+/******************************************************************************
+ * Copyright (c) 2018 Microsoft Corporation and others.
+ * 
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0,
+ * or the Eclipse Distribution License v. 1.0 which is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
+ * 
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ******************************************************************************/
+package org.eclipse.lsp4j.adapters;
+
+import java.util.ArrayList;
+import java.util.function.Predicate;
+
+import org.eclipse.lsp4j.PrepareRenameResult;
+import org.eclipse.lsp4j.Range;
+import org.eclipse.lsp4j.jsonrpc.json.adapters.CollectionTypeAdapter;
+import org.eclipse.lsp4j.jsonrpc.json.adapters.EitherTypeAdapter;
+import org.eclipse.lsp4j.jsonrpc.json.adapters.EitherTypeAdapter.PropertyChecker;
+import org.eclipse.lsp4j.jsonrpc.messages.Either;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonElement;
+import com.google.gson.TypeAdapter;
+import com.google.gson.TypeAdapterFactory;
+import com.google.gson.reflect.TypeToken;
+
+public class PrepareRenameResponseAdapter implements TypeAdapterFactory {
+
+	private static final TypeToken<Either<Range, PrepareRenameResult>> ELEMENT_TYPE
+			= new TypeToken<Either<Range, PrepareRenameResult>>() {};
+
+	@SuppressWarnings("unchecked")
+	@Override
+	public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
+		Predicate<JsonElement> leftChecker = new PropertyChecker("start");
+		Predicate<JsonElement> rightChecker = new PropertyChecker("range");
+		TypeAdapter<Either<Range, PrepareRenameResult>> elementTypeAdapter = new EitherTypeAdapter<>(gson, ELEMENT_TYPE,
+				leftChecker, rightChecker);
+		return (TypeAdapter<T>) new CollectionTypeAdapter<>(gson, ELEMENT_TYPE.getType(), elementTypeAdapter,
+				ArrayList::new);
+	}
+}

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/adapters/ResourceOperationTypeAdapter.java

@@ -1,5 +1,5 @@
 /******************************************************************************
- * Copyright (c) 2018 TypeFox and others.
+ * Copyright (c) 2018 Microsoft Corporation and others.
  * 
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -23,6 +23,8 @@
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
+import com.google.gson.JsonParser;
 import com.google.gson.TypeAdapter;
 import com.google.gson.TypeAdapterFactory;
 import com.google.gson.reflect.TypeToken;
@@ -44,21 +46,18 @@ public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
 
 	private static class InnerResourceOperationTypeAdapter extends TypeAdapter<ResourceOperation> {
 
-		TypeAdapter<JsonElement> jsonElementAdapter;
 		TypeAdapter<CreateFile> createFileAdapter;
 		TypeAdapter<DeleteFile> deleteFileAdapter;
 		TypeAdapter<RenameFile> renameFileAdapter;
 
 		InnerResourceOperationTypeAdapter(TypeAdapterFactory factory, Gson gson) {
-			jsonElementAdapter = gson.getAdapter(JsonElement.class);
 			createFileAdapter = gson.getDelegateAdapter(factory, TypeToken.get(CreateFile.class));
 			deleteFileAdapter = gson.getDelegateAdapter(factory, TypeToken.get(DeleteFile.class));
 			renameFileAdapter = gson.getDelegateAdapter(factory, TypeToken.get(RenameFile.class));
 		}
 
 		@Override
 		public void write(JsonWriter out, ResourceOperation value) throws IOException {
-
 			if (value.getClass().isAssignableFrom(CreateFile.class)) {
 				createFileAdapter.write(out, (CreateFile) value);
 			} else if (value.getClass().isAssignableFrom(DeleteFile.class)) {
@@ -70,7 +69,7 @@ public void write(JsonWriter out, ResourceOperation value) throws IOException {
 
 		@Override
 		public ResourceOperation read(JsonReader in) throws IOException {
-			JsonObject objectJson = jsonElementAdapter.read(in).getAsJsonObject();
+			JsonObject objectJson = new JsonParser().parse(in).getAsJsonObject();
 			JsonElement value = objectJson.get("kind");
 			if (value != null && value.isJsonPrimitive()) {
 				String kindValue = value.getAsString();
@@ -84,7 +83,8 @@ public ResourceOperation read(JsonReader in) throws IOException {
 				}
 			}
 
-			return null;
+			throw new JsonParseException(
+					"The ResourceOperation object either has null \"kind\" value or the \"kind\" value is not valid.");
 		}
 	}
 }

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/services/TextDocumentService.java

@@ -54,6 +54,7 @@
 import org.eclipse.lsp4j.WorkspaceEdit;
 import org.eclipse.lsp4j.adapters.CodeActionResponseAdapter;
 import org.eclipse.lsp4j.adapters.DocumentSymbolResponseAdapter;
+import org.eclipse.lsp4j.adapters.PrepareRenameResponseAdapter;
 import org.eclipse.lsp4j.jsonrpc.json.ResponseJsonAdapter;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.eclipse.lsp4j.jsonrpc.services.JsonNotification;
@@ -384,8 +385,8 @@ default CompletableFuture<List<FoldingRange>> foldingRange(FoldingRangeRequestPa
 	 * Since version 3.12.0
 	 */
 	@JsonRequest
+	@ResponseJsonAdapter(PrepareRenameResponseAdapter.class)
 	default CompletableFuture<Either<Range, PrepareRenameResult>> prepareRename(TextDocumentPositionParams params) {
 		throw new UnsupportedOperationException();
 	}
-
 }

org.eclipse.lsp4j/src/main/xtend-gen/org/eclipse/lsp4j/PrepareRenameResult.java

@@ -19,11 +19,14 @@
 @SuppressWarnings("all")
 public class PrepareRenameResult {
   /**
-   * The capabilities the language server provides.
+   * The range of the string to rename
    */
   @NonNull
   private Range range;
 
+  /**
+   * A placeholder text of the string content to be renamed.
+   */
   @NonNull
   private String placeholder;
 
@@ -36,7 +39,7 @@ public PrepareRenameResult(@NonNull final Range range, @NonNull final String pla
   }
 
   /**
-   * The capabilities the language server provides.
+   * The range of the string to rename
    */
   @Pure
   @NonNull
@@ -45,18 +48,24 @@ public Range getRange() {
   }
 
   /**
-   * The capabilities the language server provides.
+   * The range of the string to rename
    */
   public void setRange(@NonNull final Range range) {
     this.range = range;
   }
 
+  /**
+   * A placeholder text of the string content to be renamed.
+   */
   @Pure
   @NonNull
   public String getPlaceholder() {
     return this.placeholder;
   }
 
+  /**
+   * A placeholder text of the string content to be renamed.
+   */
   public void setPlaceholder(@NonNull final String placeholder) {
     this.placeholder = placeholder;
   }

org.eclipse.lsp4j/src/main/xtend-gen/org/eclipse/lsp4j/RenameCapabilities.java

@@ -20,17 +20,46 @@
  */
 @SuppressWarnings("all")
 public class RenameCapabilities extends DynamicRegistrationCapabilities {
+  /**
+   * Client supports testing for validity of rename operations
+   * before execution.
+   */
+  private Boolean prepareSupport;
+
   public RenameCapabilities() {
   }
 
   public RenameCapabilities(final Boolean dynamicRegistration) {
     super(dynamicRegistration);
   }
 
+  public RenameCapabilities(final Boolean prepareSupport, final Boolean dynamicRegistration) {
+    super(dynamicRegistration);
+    this.prepareSupport = prepareSupport;
+  }
+
+  /**
+   * Client supports testing for validity of rename operations
+   * before execution.
+   */
+  @Pure
+  public Boolean getPrepareSupport() {
+    return this.prepareSupport;
+  }
+
+  /**
+   * Client supports testing for validity of rename operations
+   * before execution.
+   */
+  public void setPrepareSupport(final Boolean prepareSupport) {
+    this.prepareSupport = prepareSupport;
+  }
+
   @Override
   @Pure
   public String toString() {
     ToStringBuilder b = new ToStringBuilder(this);
+    b.add("prepareSupport", this.prepareSupport);
     b.add("dynamicRegistration", getDynamicRegistration());
     return b.toString();
   }
@@ -46,12 +75,18 @@ public boolean equals(final Object obj) {
       return false;
     if (!super.equals(obj))
       return false;
+    RenameCapabilities other = (RenameCapabilities) obj;
+    if (this.prepareSupport == null) {
+      if (other.prepareSupport != null)
+        return false;
+    } else if (!this.prepareSupport.equals(other.prepareSupport))
+      return false;
     return true;
   }
 
   @Override
   @Pure
   public int hashCode() {
-    return super.hashCode();
+    return 31 * super.hashCode() + ((this.prepareSupport== null) ? 0 : this.prepareSupport.hashCode());
   }
 }