Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CodeActionCapabilities

extends DynamicRegistrationCapabilities
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Capabilities specific to the `textDocument/codeAction`

Field Summary

Modifier and TypeField and Description
private CodeActionLiteralSupportCapabilities
codeActionLiteralSupport

The client support code action literals as a valid response of the `textDocument/codeAction` request.

private Boolean
dataSupport

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

private Boolean
disabledSupport

Whether code action supports the CodeAction#disabled property.

private Boolean
honorsChangeAnnotations

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

private Boolean
isPreferredSupport

Whether code action supports the CodeAction#isPreferred property.

private CodeActionResolveSupportCapabilities
resolveSupport

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

Constructor Summary

AccessConstructor and Description
public
public
CodeActionCapabilities(final Boolean dynamicRegistration)

public
CodeActionCapabilities(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport, final Boolean dynamicRegistration)

public
CodeActionCapabilities(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport, final Boolean dynamicRegistration, final Boolean isPreferredSupport)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.equals.

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

public CodeActionLiteralSupportCapabilities
getCodeActionLiteralSupport()

The client support code action literals as a valid response of the `textDocument/codeAction` request.

public Boolean
getDataSupport()

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

public Boolean
getDisabledSupport()

Whether code action supports the CodeAction#disabled property.

public Boolean
getHonorsChangeAnnotations()

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

public Boolean
getIsPreferredSupport()

Whether code action supports the CodeAction#isPreferred property.

public CodeActionResolveSupportCapabilities
getResolveSupport()

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

public int
hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.hashCode.

Returns a hash code value for this object.

public void
setCodeActionLiteralSupport(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport)

The client support code action literals as a valid response of the `textDocument/codeAction` request.

public void
setDataSupport(final Boolean dataSupport)

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

public void
setDisabledSupport(final Boolean disabledSupport)

Whether code action supports the CodeAction#disabled property.

public void
setHonorsChangeAnnotations(final Boolean honorsChangeAnnotations)

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

public void
setIsPreferredSupport(final Boolean isPreferredSupport)

Whether code action supports the CodeAction#isPreferred property.

public void
setResolveSupport(final CodeActionResolveSupportCapabilities resolveSupport)

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

public String
toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.DynamicRegistrationCapabilities:
getDynamicRegistrationsetDynamicRegistration

Field Detail

codeActionLiteralSupportback to summary
private CodeActionLiteralSupportCapabilities codeActionLiteralSupport

The client support code action literals as a valid response of the `textDocument/codeAction` request.

dataSupportback to summary
private Boolean dataSupport

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

Since 3.16.0

disabledSupportback to summary
private Boolean disabledSupport

Whether code action supports the CodeAction#disabled property.

Since 3.16.0

honorsChangeAnnotationsback to summary
private Boolean honorsChangeAnnotations

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

Since 3.16.0

isPreferredSupportback to summary
private Boolean isPreferredSupport

Whether code action supports the CodeAction#isPreferred property.

Since 3.15.0

resolveSupportback to summary
private CodeActionResolveSupportCapabilities resolveSupport

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

Since 3.16.0

Constructor Detail

CodeActionCapabilitiesback to summary
public CodeActionCapabilities()
CodeActionCapabilitiesback to summary
public CodeActionCapabilities(final Boolean dynamicRegistration)
CodeActionCapabilitiesback to summary
public CodeActionCapabilities(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport, final Boolean dynamicRegistration)
CodeActionCapabilitiesback to summary
public CodeActionCapabilities(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport, final Boolean dynamicRegistration, final Boolean isPreferredSupport)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
getCodeActionLiteralSupportback to summary
public CodeActionLiteralSupportCapabilities getCodeActionLiteralSupport()

The client support code action literals as a valid response of the `textDocument/codeAction` request.

getDataSupportback to summary
public Boolean getDataSupport()

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

Since 3.16.0

getDisabledSupportback to summary
public Boolean getDisabledSupport()

Whether code action supports the CodeAction#disabled property.

Since 3.16.0

getHonorsChangeAnnotationsback to summary
public Boolean getHonorsChangeAnnotations()

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

Since 3.16.0

getIsPreferredSupportback to summary
public Boolean getIsPreferredSupport()

Whether code action supports the CodeAction#isPreferred property.

Since 3.15.0

getResolveSupportback to summary
public CodeActionResolveSupportCapabilities getResolveSupport()

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

Since 3.16.0

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
setCodeActionLiteralSupportback to summary
public void setCodeActionLiteralSupport(final CodeActionLiteralSupportCapabilities codeActionLiteralSupport)

The client support code action literals as a valid response of the `textDocument/codeAction` request.

setDataSupportback to summary
public void setDataSupport(final Boolean dataSupport)

Whether code action supports the CodeAction#data property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.

Since 3.16.0

setDisabledSupportback to summary
public void setDisabledSupport(final Boolean disabledSupport)

Whether code action supports the CodeAction#disabled property.

Since 3.16.0

setHonorsChangeAnnotationsback to summary
public void setHonorsChangeAnnotations(final Boolean honorsChangeAnnotations)

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

Since 3.16.0

setIsPreferredSupportback to summary
public void setIsPreferredSupport(final Boolean isPreferredSupport)

Whether code action supports the CodeAction#isPreferred property.

Since 3.15.0

setResolveSupportback to summary
public void setResolveSupport(final CodeActionResolveSupportCapabilities resolveSupport)

Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.

Since 3.16.0

toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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