Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.CodeActionContext

Modifier and Type	Field and Description
private List<Diagnostic>	diagnostics An array of diagnostics.
private List<String>	only Requested kind of actions to return.
private CodeActionTriggerKind	triggerKind The reason why code actions were requested.

Access	Constructor and Description
public	CodeActionContext()
public	CodeActionContext(final List<Diagnostic> diagnostics)
public	CodeActionContext(final List<Diagnostic> diagnostics, final List<String> only)

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 List<Diagnostic>	getDiagnostics() An array of diagnostics.
public List<String>	getOnly() Requested kind of actions to return.
public CodeActionTriggerKind	getTriggerKind() The reason why code actions were requested.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setDiagnostics(final List<Diagnostic> diagnostics) An array of diagnostics.
public void	setOnly(final List<String> only) Requested kind of actions to return.
public void	setTriggerKind(final CodeActionTriggerKind triggerKind) The reason why code actions were requested.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

diagnostics	back to summary
private List<Diagnostic> diagnostics An array of diagnostics. Annotations @NonNull

only back to summary

only	back to summary
private List<String> only Requested kind of actions to return. Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them. See `CodeActionKind` for some predefined code action kinds.

private List<String> only

Requested kind of actions to return.

Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.

See CodeActionKind for some predefined code action kinds.

triggerKind	back to summary
private CodeActionTriggerKind triggerKind The reason why code actions were requested. Since 3.17.0

triggerKind

back to summary

private CodeActionTriggerKind triggerKind

The reason why code actions were requested.

Since 3.17.0

Constructor Detail

CodeActionContext	back to summary
public CodeActionContext()

CodeActionContext	back to summary
public CodeActionContext(final List<Diagnostic> diagnostics)

CodeActionContext	back to summary
public CodeActionContext(final List<Diagnostic> diagnostics, final List<String> only)

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

getDiagnostics	back to summary
public List<Diagnostic> getDiagnostics() An array of diagnostics. Annotations @NonNull

getDiagnostics

back to summary

public List<Diagnostic> getDiagnostics()

An array of diagnostics.

Annotations

@NonNull

getOnly back to summary

getOnly	back to summary
public List<String> getOnly() Requested kind of actions to return. Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them. See `CodeActionKind` for some predefined code action kinds.

public List<String> getOnly()

Requested kind of actions to return.

Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.

See CodeActionKind for some predefined code action kinds.

getTriggerKind	back to summary
public CodeActionTriggerKind getTriggerKind() The reason why code actions were requested. Since 3.17.0

getTriggerKind

back to summary

public CodeActionTriggerKind getTriggerKind()

The reason why code actions were requested.

Since 3.17.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

setDiagnostics	back to summary
public void setDiagnostics(final List<Diagnostic> diagnostics) An array of diagnostics.

setOnly back to summary

setOnly	back to summary
public void setOnly(final List<String> only) Requested kind of actions to return. Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them. See `CodeActionKind` for some predefined code action kinds.

public void setOnly(final List<String> only)

Requested kind of actions to return.

Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.

See CodeActionKind for some predefined code action kinds.

setTriggerKind	back to summary
public void setTriggerKind(final CodeActionTriggerKind triggerKind) The reason why code actions were requested. Since 3.17.0

setTriggerKind

back to summary

public void setTriggerKind(final CodeActionTriggerKind triggerKind)

The reason why code actions were requested.

Since 3.17.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 CodeActionContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail