org.netbeans.api.lsp

Class WorkspaceEdit

java.lang.Object

org.netbeans.api.lsp.WorkspaceEdit

public class WorkspaceEdit
extends Object

A set of edits over the workspace.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
WorkspaceEdit(List<Union2<TextDocumentEdit,ResourceOperation>> documentChanges) Construct a new WorkspaceEdit.

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<List<String>>	applyEdits(List<WorkspaceEdit> edits, boolean save) Attempts to apply workspace edits to the resources.
List<Union2<TextDocumentEdit,ResourceOperation>>	getDocumentChanges() The changes to documents in the workspace that need to be performed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkspaceEdit

public WorkspaceEdit(List<Union2<TextDocumentEdit,ResourceOperation>> documentChanges)

Construct a new WorkspaceEdit.

Parameters:

documentChanges - the changes to documents in the workspace that need to be performed.

Method Detail

getDocumentChanges

public List<Union2<TextDocumentEdit,ResourceOperation>> getDocumentChanges()

The changes to documents in the workspace that need to be performed.

Returns:

the changes to documents in the workspace that need to be performed

applyEdits

public static CompletableFuture<List<String>> applyEdits(List<WorkspaceEdit> edits,
                                                         boolean save)

Attempts to apply workspace edits to the resources. The resource(s) are optionally saved after modification. The caller may request just save of the resources, by supplying a WorkspaceEdit with TextDocumentEdits that have empty set of changes. The implementation must apply edits so they result in the same result as if the contents of the WorkspaceEdit are applied in the order. Upon failure, the returned Future completes with ResourceModificationException. Completed WorkspaceEdits, the failed one and the index of a failed operation within it should be reported. If any resource was saved before the failure, it should be reported as saved.

Parameters:

edits - edits to apply.

save - if true, resources are saved after they are modified.

Returns:

future that completes with a list of resource URIs modified, or fails with ResourceModificationException.

Since:

1.27