Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.WorkspaceEditCapabilities

Modifier and Type	Field and Description
private WorkspaceEditChangeAnnotationSupportCapabilities	changeAnnotationSupport Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
private Boolean	documentChanges The client supports versioned document changes in `WorkspaceEdit`s
private String	failureHandling The failure handling strategy of a client if applying the workspace edit fails.
private Boolean	normalizesLineEndings Whether the client normalizes line endings to the client specific setting.
private List<String>	resourceOperations The resource operations the client supports.

Access	Constructor and Description
public	WorkspaceEditCapabilities()
public	WorkspaceEditCapabilities(final Boolean documentChanges) Deprecated because when this class first existed it didn't have any other fields. Now that this class has lots of fields, there is nothing special about this field and therefore using the setters is the recommended use case.

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 WorkspaceEditChangeAnnotationSupportCapabilities	getChangeAnnotationSupport() Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
public Boolean	getDocumentChanges() The client supports versioned document changes in `WorkspaceEdit`s
public String	getFailureHandling() The failure handling strategy of a client if applying the workspace edit fails.
public Boolean	getNormalizesLineEndings() Whether the client normalizes line endings to the client specific setting.
public List<String>	getResourceOperations() The resource operations the client supports.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setChangeAnnotationSupport(final WorkspaceEditChangeAnnotationSupportCapabilities changeAnnotationSupport) Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
public void	setDocumentChanges(final Boolean documentChanges) The client supports versioned document changes in `WorkspaceEdit`s
public void	setFailureHandling(final String failureHandling) The failure handling strategy of a client if applying the workspace edit fails.
public void	setNormalizesLineEndings(final Boolean normalizesLineEndings) Whether the client normalizes line endings to the client specific setting.
public void	setResourceOperations(final List<String> resourceOperations) The resource operations the client supports.
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

changeAnnotationSupport	back to summary
private WorkspaceEditChangeAnnotationSupportCapabilities changeAnnotationSupport Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes. Since 3.16.0

documentChanges	back to summary
private Boolean documentChanges The client supports versioned document changes in `WorkspaceEdit`s

failureHandling	back to summary
private String failureHandling The failure handling strategy of a client if applying the workspace edit fails. See `FailureHandlingKind` for allowed values. Since 3.13.0

normalizesLineEndings	back to summary
private Boolean normalizesLineEndings Whether the client normalizes line endings to the client specific setting. If set to `true` the client will normalize line ending characters in a workspace edit to the client specific new line character(s). Since 3.16.0

resourceOperations	back to summary
private List<String> resourceOperations The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders. See `ResourceOperationKind` for allowed values. Since 3.13.0

WorkspaceEditCapabilities	back to summary
public WorkspaceEditCapabilities()

WorkspaceEditCapabilities	back to summary
public WorkspaceEditCapabilities(final Boolean documentChanges) Deprecated because when this class first existed it didn't have any other fields. Now that this class has lots of fields, there is nothing special about this field and therefore using the setters is the recommended use case. Annotations @Deprecated

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

getChangeAnnotationSupport	back to summary
public WorkspaceEditChangeAnnotationSupportCapabilities getChangeAnnotationSupport() Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes. Since 3.16.0

getChangeAnnotationSupport

back to summary

public WorkspaceEditChangeAnnotationSupportCapabilities getChangeAnnotationSupport()

Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.

Since 3.16.0

getDocumentChanges	back to summary
public Boolean getDocumentChanges() The client supports versioned document changes in `WorkspaceEdit`s

getFailureHandling back to summary

getFailureHandling	back to summary
public String getFailureHandling() The failure handling strategy of a client if applying the workspace edit fails. See `FailureHandlingKind` for allowed values. Since 3.13.0

public String getFailureHandling()

The failure handling strategy of a client if applying the workspace edit fails.

See FailureHandlingKind for allowed values.

Since 3.13.0

getNormalizesLineEndings back to summary

getNormalizesLineEndings	back to summary
public Boolean getNormalizesLineEndings() Whether the client normalizes line endings to the client specific setting. If set to `true` the client will normalize line ending characters in a workspace edit to the client specific new line character(s). Since 3.16.0

public Boolean getNormalizesLineEndings()

Whether the client normalizes line endings to the client specific setting.

If set to true the client will normalize line ending characters in a workspace edit to the client specific new line character(s).

Since 3.16.0

getResourceOperations back to summary

getResourceOperations	back to summary
public List<String> getResourceOperations() The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders. See `ResourceOperationKind` for allowed values. Since 3.13.0

public List<String> getResourceOperations()

The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders.

See ResourceOperationKind for allowed values.

Since 3.13.0

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

setChangeAnnotationSupport	back to summary
public void setChangeAnnotationSupport(final WorkspaceEditChangeAnnotationSupportCapabilities changeAnnotationSupport) Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes. Since 3.16.0

setChangeAnnotationSupport

back to summary

public void setChangeAnnotationSupport(final WorkspaceEditChangeAnnotationSupportCapabilities changeAnnotationSupport)

Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.

Since 3.16.0

setDocumentChanges	back to summary
public void setDocumentChanges(final Boolean documentChanges) The client supports versioned document changes in `WorkspaceEdit`s

setFailureHandling back to summary

setFailureHandling	back to summary
public void setFailureHandling(final String failureHandling) The failure handling strategy of a client if applying the workspace edit fails. See `FailureHandlingKind` for allowed values. Since 3.13.0

public void setFailureHandling(final String failureHandling)

The failure handling strategy of a client if applying the workspace edit fails.

See FailureHandlingKind for allowed values.

Since 3.13.0

setNormalizesLineEndings back to summary

setNormalizesLineEndings	back to summary
public void setNormalizesLineEndings(final Boolean normalizesLineEndings) Whether the client normalizes line endings to the client specific setting. If set to `true` the client will normalize line ending characters in a workspace edit to the client specific new line character(s). Since 3.16.0

public void setNormalizesLineEndings(final Boolean normalizesLineEndings)

Whether the client normalizes line endings to the client specific setting.

If set to true the client will normalize line ending characters in a workspace edit to the client specific new line character(s).

Since 3.16.0

setResourceOperations back to summary

setResourceOperations	back to summary
public void setResourceOperations(final List<String> resourceOperations) The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders. See `ResourceOperationKind` for allowed values. Since 3.13.0

public void setResourceOperations(final List<String> resourceOperations)

The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders.

See ResourceOperationKind for allowed values.

Since 3.13.0

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 WorkspaceEditCapabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail