org.eclipse.lsp4j

Class WorkspaceEdit

java.lang.Object

org.eclipse.lsp4j.WorkspaceEdit

public class WorkspaceEdit
extends java.lang.Object

A workspace edit represents changes to many resources managed in the workspace. The edit should either provide changes or documentChanges. If documentChanges are present they are preferred over changes if the client can handle versioned document edits.

Constructor Summary

Constructors

Constructor and Description
WorkspaceEdit()
WorkspaceEdit(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>> documentChanges)
WorkspaceEdit(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,ChangeAnnotation>	getChangeAnnotations() A map of change annotations that can be referenced in AnnotatedTextEdits or ResourceOperations.
java.util.Map<java.lang.String,java.util.List<TextEdit>>	getChanges() Holds changes to existing resources.
java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>>	getDocumentChanges() Depending on the client capability WorkspaceEditCapabilities.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document.
java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>>	getResourceChanges() Deprecated. Since LSP introduces resource operations, use the documentChanges instead
int	hashCode()
void	setChangeAnnotations(java.util.Map<java.lang.String,ChangeAnnotation> changeAnnotations) A map of change annotations that can be referenced in AnnotatedTextEdits or ResourceOperations.
void	setChanges(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes) Holds changes to existing resources.
void	setDocumentChanges(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>> documentChanges) Depending on the client capability WorkspaceEditCapabilities.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document.
void	setResourceChanges(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>> resourceChanges) Deprecated. Since LSP introduces resource operations, use the documentChanges instead
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkspaceEdit

public WorkspaceEdit()

WorkspaceEdit

public WorkspaceEdit(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes)

WorkspaceEdit

public WorkspaceEdit(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>> documentChanges)

Method Detail

getChanges

@Pure
public java.util.Map<java.lang.String,java.util.List<TextEdit>> getChanges()

Holds changes to existing resources.

setChanges

public void setChanges(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes)

Holds changes to existing resources.

getDocumentChanges

@Pure
public java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>> getDocumentChanges()

Depending on the client capability WorkspaceEditCapabilities.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain above TextDocumentEdits mixed with create, rename and delete file / folder operations. Whether a client supports versioned document edits is expressed via WorkspaceEditCapabilities.documentChanges client capability. If a client neither supports WorkspaceEditCapabilities.documentChanges nor WorkspaceEditCapabilities.resourceOperations then only plain TextEdits using the changes property are supported.

setDocumentChanges

public void setDocumentChanges(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentEdit,ResourceOperation>> documentChanges)

Depending on the client capability WorkspaceEditCapabilities.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain above TextDocumentEdits mixed with create, rename and delete file / folder operations. Whether a client supports versioned document edits is expressed via WorkspaceEditCapabilities.documentChanges client capability. If a client neither supports WorkspaceEditCapabilities.documentChanges nor WorkspaceEditCapabilities.resourceOperations then only plain TextEdits using the changes property are supported.

getResourceChanges

@Pure
 @Deprecated
public java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>> getResourceChanges()

Deprecated. Since LSP introduces resource operations, use the documentChanges instead

If resource changes are supported the `WorkspaceEdit` uses the property `resourceChanges` which are either a 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

setResourceChanges

@Deprecated
public void setResourceChanges(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>> resourceChanges)

Deprecated. Since LSP introduces resource operations, use the documentChanges instead

If resource changes are supported the `WorkspaceEdit` uses the property `resourceChanges` which are either a 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

getChangeAnnotations

@Pure
public java.util.Map<java.lang.String,ChangeAnnotation> getChangeAnnotations()

A map of change annotations that can be referenced in AnnotatedTextEdits or ResourceOperations. Client support depends on WorkspaceEditCapabilities.changeAnnotationSupport. Since 3.16.0

setChangeAnnotations

public void setChangeAnnotations(java.util.Map<java.lang.String,ChangeAnnotation> changeAnnotations)

A map of change annotations that can be referenced in AnnotatedTextEdits or ResourceOperations. Client support depends on WorkspaceEditCapabilities.changeAnnotationSupport. Since 3.16.0

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object