Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CodeActionRegistrationOptions

extends AbstractTextDocumentRegistrationAndWorkDoneProgressOptions
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
java.util.List, org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Code Action registration options.

Field Summary

Modifier and TypeField and Description
private List<String>
codeActionKinds

CodeActionKinds that this server may return.

private Boolean
resolveProvider

The server provides support to resolve additional information for a code action.

Constructor Summary

AccessConstructor and Description
public
public
CodeActionRegistrationOptions(final List<String> codeActionKinds)

Method Summary

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

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.equals.

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

public List<String>
getCodeActionKinds()

CodeActionKinds that this server may return.

public Boolean
getResolveProvider()

The server provides support to resolve additional information for a code action.

public int
public void
setCodeActionKinds(final List<String> codeActionKinds)

CodeActionKinds that this server may return.

public void
setResolveProvider(final Boolean resolveProvider)

The server provides support to resolve additional information for a code action.

public String
Inherited from org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions:
getWorkDoneProgresssetWorkDoneProgress

Field Detail

codeActionKindsback to summary
private List<String> codeActionKinds

CodeActionKinds that this server may return.

The list of kinds may be generic, such as CodeActionKind#Refactor, or the server may list out every specific kind they provide.

Since 3.11.0

resolveProviderback to summary
private Boolean resolveProvider

The server provides support to resolve additional information for a code action.

Since 3.16.0

Constructor Detail

CodeActionRegistrationOptionsback to summary
public CodeActionRegistrationOptions()
CodeActionRegistrationOptionsback to summary
public CodeActionRegistrationOptions(final List<String> codeActionKinds)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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
getCodeActionKindsback to summary
public List<String> getCodeActionKinds()

CodeActionKinds that this server may return.

The list of kinds may be generic, such as CodeActionKind#Refactor, or the server may list out every specific kind they provide.

Since 3.11.0

getResolveProviderback to summary
public Boolean getResolveProvider()

The server provides support to resolve additional information for a code action.

Since 3.16.0

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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
setCodeActionKindsback to summary
public void setCodeActionKinds(final List<String> codeActionKinds)

CodeActionKinds that this server may return.

The list of kinds may be generic, such as CodeActionKind#Refactor, or the server may list out every specific kind they provide.

Since 3.11.0

setResolveProviderback to summary
public void setResolveProvider(final Boolean resolveProvider)

The server provides support to resolve additional information for a code action.

Since 3.16.0

toStringback to summary
public String toString()

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