Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.CodeAction · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Command	command A command this code action executes.
private Object	data A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.
private List<Diagnostic>	diagnostics The diagnostics that this code action resolves.
private CodeActionDisabled	disabled Marks that the code action cannot currently be applied.
private WorkspaceEdit	edit The workspace edit this code action performs.
private Boolean	isPreferred Marks this as a preferred action.
private String	kind The kind of the code action.
private String	title A short, human-readable, title for this code action.

Access	Constructor and Description
public	CodeAction()
public	CodeAction(final String title)

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 Command	getCommand() A command this code action executes.
public Object	getData() A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.
public List<Diagnostic>	getDiagnostics() The diagnostics that this code action resolves.
public CodeActionDisabled	getDisabled() Marks that the code action cannot currently be applied.
public WorkspaceEdit	getEdit() The workspace edit this code action performs.
public Boolean	getIsPreferred() Marks this as a preferred action.
public String	getKind() The kind of the code action.
public String	getTitle() A short, human-readable, title for this code action.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCommand(final Command command) A command this code action executes.
public void	setData(final Object data) A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.
public void	setDiagnostics(final List<Diagnostic> diagnostics) The diagnostics that this code action resolves.
public void	setDisabled(final CodeActionDisabled disabled) Marks that the code action cannot currently be applied.
public void	setEdit(final WorkspaceEdit edit) The workspace edit this code action performs.
public void	setIsPreferred(final Boolean isPreferred) Marks this as a preferred action.
public void	setKind(final String kind) The kind of the code action.
public void	setTitle(final String title) A short, human-readable, title for this code action.
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

command	back to summary
private Command command A command this code action executes. If a code action provides a edit and a command, first the edit is executed and then the command.

data	back to summary
private Object data A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request. Since 3.16.0 Annotations @JsonAdapter:Factory

diagnostics	back to summary
private List<Diagnostic> diagnostics The diagnostics that this code action resolves.

disabled back to summary

disabled	back to summary
private CodeActionDisabled disabled Marks that the code action cannot currently be applied. Clients should follow the following guidelines regarding disabled code actions: Disabled code actions are not shown in automatic lightbulb code action menu. Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings. If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with `CodeActionDisabled#reason` in the editor. Since 3.16.0

private CodeActionDisabled disabled

Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

Disabled code actions are not shown in automatic lightbulb code action menu.
Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings.
If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with CodeActionDisabled#reason in the editor.

Since 3.16.0

edit	back to summary
private WorkspaceEdit edit The workspace edit this code action performs.

isPreferred	back to summary
private Boolean isPreferred Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings. A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take. Since 3.15.0

isPreferred

back to summary

private Boolean isPreferred

Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings.

A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

Since 3.15.0

kind back to summary

kind	back to summary
private String kind The kind of the code action. Used to filter code actions. See `CodeActionKind` for some predefined code action kinds.

private String kind

The kind of the code action.

Used to filter code actions.

See CodeActionKind for some predefined code action kinds.

title	back to summary
private String title A short, human-readable, title for this code action. Annotations @NonNull

Constructor Detail

CodeAction	back to summary
public CodeAction()

CodeAction	back to summary
public CodeAction(final String title)

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

getCommand	back to summary
public Command getCommand() A command this code action executes. If a code action provides a edit and a command, first the edit is executed and then the command.

getData	back to summary
public Object getData() A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request. Since 3.16.0

getData

back to summary

public Object getData()

A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.

Since 3.16.0

getDiagnostics	back to summary
public List<Diagnostic> getDiagnostics() The diagnostics that this code action resolves.

getDisabled back to summary

getDisabled	back to summary
public CodeActionDisabled getDisabled() Marks that the code action cannot currently be applied. Clients should follow the following guidelines regarding disabled code actions: Disabled code actions are not shown in automatic lightbulb code action menu. Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings. If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with `CodeActionDisabled#reason` in the editor. Since 3.16.0

public CodeActionDisabled getDisabled()

Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

Disabled code actions are not shown in automatic lightbulb code action menu.
Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings.
If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with CodeActionDisabled#reason in the editor.

Since 3.16.0

getEdit	back to summary
public WorkspaceEdit getEdit() The workspace edit this code action performs.

getIsPreferred	back to summary
public Boolean getIsPreferred() Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings. A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take. Since 3.15.0

getIsPreferred

back to summary

public Boolean getIsPreferred()

Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings.

A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

Since 3.15.0

getKind back to summary

getKind	back to summary
public String getKind() The kind of the code action. Used to filter code actions. See `CodeActionKind` for some predefined code action kinds.

public String getKind()

The kind of the code action.

Used to filter code actions.

See CodeActionKind for some predefined code action kinds.

getTitle	back to summary
public String getTitle() A short, human-readable, title for this code action. Annotations @NonNull

getTitle

back to summary

public String getTitle()

A short, human-readable, title for this code action.

Annotations

@NonNull

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

setCommand	back to summary
public void setCommand(final Command command) A command this code action executes. If a code action provides a edit and a command, first the edit is executed and then the command.

setData	back to summary
public void setData(final Object data) A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request. Since 3.16.0

setData

back to summary

public void setData(final Object data)

A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.

Since 3.16.0

setDiagnostics	back to summary
public void setDiagnostics(final List<Diagnostic> diagnostics) The diagnostics that this code action resolves.

setDisabled back to summary

setDisabled	back to summary
public void setDisabled(final CodeActionDisabled disabled) Marks that the code action cannot currently be applied. Clients should follow the following guidelines regarding disabled code actions: Disabled code actions are not shown in automatic lightbulb code action menu. Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings. If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with `CodeActionDisabled#reason` in the editor. Since 3.16.0

public void setDisabled(final CodeActionDisabled disabled)

Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

Disabled code actions are not shown in automatic lightbulb code action menu.
Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings.
If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with CodeActionDisabled#reason in the editor.

Since 3.16.0

setEdit	back to summary
public void setEdit(final WorkspaceEdit edit) The workspace edit this code action performs.

setIsPreferred	back to summary
public void setIsPreferred(final Boolean isPreferred) Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings. A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take. Since 3.15.0

setIsPreferred

back to summary

public void setIsPreferred(final Boolean isPreferred)

Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings.

A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

Since 3.15.0

setKind back to summary

setKind	back to summary
public void setKind(final String kind) The kind of the code action. Used to filter code actions. See `CodeActionKind` for some predefined code action kinds.

public void setKind(final String kind)

The kind of the code action.

Used to filter code actions.

See CodeActionKind for some predefined code action kinds.

setTitle	back to summary
public void setTitle(final String title) A short, human-readable, title for this code action.

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 CodeAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail