Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.ApplyWorkspaceEditResponse

Modifier and Type	Field and Description
private boolean	applied Indicates whether the edit was applied or not.
private Integer	failedChange Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed.
private String	failureReason An optional textual description for why the edit was not applied.

Access	Constructor and Description
public	ApplyWorkspaceEditResponse()
public	ApplyWorkspaceEditResponse(final boolean applied)

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 Integer	getFailedChange() Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed.
public String	getFailureReason() An optional textual description for why the edit was not applied.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isApplied() Indicates whether the edit was applied or not.
public void	setApplied(final boolean applied) Indicates whether the edit was applied or not.
public void	setFailedChange(final Integer failedChange) Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed.
public void	setFailureReason(final String failureReason) An optional textual description for why the edit was not applied.
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

applied	back to summary
private boolean applied Indicates whether the edit was applied or not.

failedChange	back to summary
private Integer failedChange Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a `WorkspaceEditCapabilities#failureHandling` strategy in its client capabilities.

failureReason	back to summary
private String failureReason An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

ApplyWorkspaceEditResponse	back to summary
public ApplyWorkspaceEditResponse()

ApplyWorkspaceEditResponse	back to summary
public ApplyWorkspaceEditResponse(final boolean applied)

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

getFailedChange	back to summary
public Integer getFailedChange() Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a `WorkspaceEditCapabilities#failureHandling` strategy in its client capabilities.

getFailureReason	back to summary
public String getFailureReason() An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

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

isApplied	back to summary
public boolean isApplied() Indicates whether the edit was applied or not.

setApplied	back to summary
public void setApplied(final boolean applied) Indicates whether the edit was applied or not.

setFailedChange	back to summary
public void setFailedChange(final Integer failedChange) Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a `WorkspaceEditCapabilities#failureHandling` strategy in its client capabilities.

setFailureReason	back to summary
public void setFailureReason(final String failureReason) An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

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 ApplyWorkspaceEditResponse

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail