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<TextDocumentEdit> documentChanges)
WorkspaceEdit(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes)
WorkspaceEdit(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes, java.util.List<TextDocumentEdit> documentChanges) Deprecated. According to the protocol documentation, it doesn't make sense to send both changes and documentChanges

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.util.List<TextEdit>>	getChanges() Holds changes to existing resources.
java.util.List<TextDocumentEdit>	getDocumentChanges() An array of `TextDocumentEdit`s to express changes to specific a specific version of a text document.
java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>>	getResourceChanges() If resource changes are supported the `WorkspaceEdit` uses the property `resourceChanges` which are either a rename, move, delete or content change.
int	hashCode()
void	setChanges(java.util.Map<java.lang.String,java.util.List<TextEdit>> changes) Holds changes to existing resources.
void	setDocumentChanges(java.util.List<TextDocumentEdit> documentChanges) An array of `TextDocumentEdit`s to express changes to specific a specific version of a text document.
void	setResourceChanges(java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<ResourceChange,TextDocumentEdit>> resourceChanges) If resource changes are supported the `WorkspaceEdit` uses the property `resourceChanges` which are either a rename, move, delete or content change.
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<TextDocumentEdit> documentChanges)

WorkspaceEdit

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

Deprecated. According to the protocol documentation, it doesn't make sense to send both changes and 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<TextDocumentEdit> getDocumentChanges()

An array of `TextDocumentEdit`s to express changes to specific a specific version of a text document. Whether a client supports versioned document edits is expressed via `WorkspaceClientCapabilities.versionedWorkspaceEdit`.

setDocumentChanges

public void setDocumentChanges(java.util.List<TextDocumentEdit> documentChanges)

An array of `TextDocumentEdit`s to express changes to specific a specific version of a text document. Whether a client supports versioned document edits is expressed via `WorkspaceClientCapabilities.versionedWorkspaceEdit`.

getResourceChanges

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

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

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

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

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