Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.WorkspaceEdit

Modifier and Type	Field and Description
private Map<String, ChangeAnnotation>	changeAnnotations A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s.
private Map<String, List<TextEdit>>	changes Holds changes to existing resources.
private List<Either<TextDocumentEdit, ResourceOperation>>	documentChanges Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s to express changes to n different text documents where each text document edit addresses a specific version of a text document.

Access	Constructor and Description
public	WorkspaceEdit()
public	WorkspaceEdit(final Map<String, List<TextEdit>> changes)
public	WorkspaceEdit(final List<Either<TextDocumentEdit, ResourceOperation>> documentChanges)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<String, ChangeAnnotation>	getChangeAnnotations() A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s.
public Map<String, List<TextEdit>>	getChanges() Holds changes to existing resources.
public List<Either<TextDocumentEdit, ResourceOperation>>	getDocumentChanges() Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s to express changes to n different text documents where each text document edit addresses a specific version of a text document.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setChangeAnnotations(final Map<String, ChangeAnnotation> changeAnnotations) A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s.
public void	setChanges(final Map<String, List<TextEdit>> changes) Holds changes to existing resources.
public void	setDocumentChanges(final List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s to express changes to n different text documents where each text document edit addresses a specific version of a text document.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

changeAnnotations back to summary

changeAnnotations	back to summary
private Map<String, ChangeAnnotation> changeAnnotations A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s. Client support depends on `WorkspaceEditCapabilities#changeAnnotationSupport`. Since 3.16.0

private Map<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

changes	back to summary
private Map<String, List<TextEdit>> changes Holds changes to existing resources.

documentChanges back to summary

documentChanges	back to summary
private List<Either<TextDocumentEdit, ResourceOperation>> documentChanges Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s 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 `TextDocumentEdit`s 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 `TextEdit`s using the `changes` property are supported. Annotations @JsonAdapter:DocumentChangeListAdapter

private List<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.

Annotations

@JsonAdapter:DocumentChangeListAdapter

Constructor Detail

WorkspaceEdit	back to summary
public WorkspaceEdit()

WorkspaceEdit	back to summary
public WorkspaceEdit(final Map<String, List<TextEdit>> changes)

WorkspaceEdit	back to summary
public WorkspaceEdit(final List<Either<TextDocumentEdit, ResourceOperation>> documentChanges)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getChangeAnnotations back to summary

getChangeAnnotations	back to summary
public Map<String, ChangeAnnotation> getChangeAnnotations() A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s. Client support depends on `WorkspaceEditCapabilities#changeAnnotationSupport`. Since 3.16.0

public Map<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

getChanges	back to summary
public Map<String, List<TextEdit>> getChanges() Holds changes to existing resources.

getDocumentChanges back to summary

getDocumentChanges	back to summary
public List<Either<TextDocumentEdit, ResourceOperation>> getDocumentChanges() Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s 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 `TextDocumentEdit`s 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 `TextEdit`s using the `changes` property are supported.

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

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.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

setChangeAnnotations back to summary

setChangeAnnotations	back to summary
public void setChangeAnnotations(final Map<String, ChangeAnnotation> changeAnnotations) A map of change annotations that can be referenced in `AnnotatedTextEdit`s or `ResourceOperation`s. Client support depends on `WorkspaceEditCapabilities#changeAnnotationSupport`. Since 3.16.0

public void setChangeAnnotations(final Map<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

setChanges	back to summary
public void setChanges(final Map<String, List<TextEdit>> changes) Holds changes to existing resources.

setDocumentChanges back to summary

setDocumentChanges	back to summary
public void setDocumentChanges(final List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) Depending on the client capability `WorkspaceEditCapabilities#resourceOperations` document changes are either an array of `TextDocumentEdit`s 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 `TextDocumentEdit`s 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 `TextEdit`s using the `changes` property are supported.

public void setDocumentChanges(final List<Either<TextDocumentEdit, ResourceOperation>> documentChanges)

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.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class WorkspaceEdit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail