Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.SemanticTokensCapabilities

Modifier and Type	Field and Description
private Boolean	augmentsSyntaxTokens Whether the client uses semantic tokens to augment existing syntax tokens.
private List<String>	formats The formats the client supports.
private Boolean	multilineTokenSupport Whether the client supports tokens that can span multiple lines.
private Boolean	overlappingTokenSupport Whether the client supports tokens that can overlap each other.
private SemanticTokensClientCapabilitiesRequests	requests Which requests the client supports and might send to the server.
private Boolean	serverCancelSupport Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`.
private List<String>	tokenModifiers The token modifiers that the client supports.
private List<String>	tokenTypes The token types that the client supports.

Access	Constructor and Description
public	SemanticTokensCapabilities()
public	SemanticTokensCapabilities(final Boolean dynamicRegistration)
public	SemanticTokensCapabilities(final SemanticTokensClientCapabilitiesRequests requests, final List<String> tokenTypes, final List<String> tokenModifiers, final List<String> formats)
public	SemanticTokensCapabilities(final Boolean dynamicRegistration, final SemanticTokensClientCapabilitiesRequests requests, final List<String> tokenTypes, final List<String> tokenModifiers, final List<String> formats)

Method Summary

Modifier and Type	Method 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 Boolean	getAugmentsSyntaxTokens() Whether the client uses semantic tokens to augment existing syntax tokens.
public List<String>	getFormats() The formats the client supports.
public Boolean	getMultilineTokenSupport() Whether the client supports tokens that can span multiple lines.
public Boolean	getOverlappingTokenSupport() Whether the client supports tokens that can overlap each other.
public SemanticTokensClientCapabilitiesRequests	getRequests() Which requests the client supports and might send to the server.
public Boolean	getServerCancelSupport() Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`.
public List<String>	getTokenModifiers() The token modifiers that the client supports.
public List<String>	getTokenTypes() The token types that the client supports.
public int	hashCode() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.hashCode. Returns a hash code value for this object.
public void	setAugmentsSyntaxTokens(final Boolean augmentsSyntaxTokens) Whether the client uses semantic tokens to augment existing syntax tokens.
public void	setFormats(final List<String> formats) The formats the client supports.
public void	setMultilineTokenSupport(final Boolean multilineTokenSupport) Whether the client supports tokens that can span multiple lines.
public void	setOverlappingTokenSupport(final Boolean overlappingTokenSupport) Whether the client supports tokens that can overlap each other.
public void	setRequests(final SemanticTokensClientCapabilitiesRequests requests) Which requests the client supports and might send to the server.
public void	setServerCancelSupport(final Boolean serverCancelSupport) Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`.
public void	setTokenModifiers(final List<String> tokenModifiers) The token modifiers that the client supports.
public void	setTokenTypes(final List<String> tokenTypes) The token types that the client supports.
public String	toString() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.toString. Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.DynamicRegistrationCapabilities:: getDynamicRegistration setDynamicRegistration

Field Detail

augmentsSyntaxTokens back to summary

augmentsSyntaxTokens	back to summary
private Boolean augmentsSyntaxTokens Whether the client uses semantic tokens to augment existing syntax tokens. If set to `true` client side created syntax tokens and semantic tokens are both used for colorization. If set to `false` the client only uses the returned semantic tokens for colorization. If the value is omitted then the client behavior is not specified. Since 3.17.0

private Boolean augmentsSyntaxTokens

Whether the client uses semantic tokens to augment existing syntax tokens. If set to true client side created syntax tokens and semantic tokens are both used for colorization. If set to false the client only uses the returned semantic tokens for colorization.

If the value is omitted then the client behavior is not specified.

Since 3.17.0

formats back to summary

formats	back to summary
private List<String> formats The formats the client supports. See `TokenFormat` for allowed values. Annotations @NonNull

private List<String> formats

The formats the client supports.

See TokenFormat for allowed values.

Annotations

@NonNull

multilineTokenSupport	back to summary
private Boolean multilineTokenSupport Whether the client supports tokens that can span multiple lines. Since 3.16.0

multilineTokenSupport

back to summary

private Boolean multilineTokenSupport

Whether the client supports tokens that can span multiple lines.

Since 3.16.0

overlappingTokenSupport	back to summary
private Boolean overlappingTokenSupport Whether the client supports tokens that can overlap each other. Since 3.16.0

overlappingTokenSupport

back to summary

private Boolean overlappingTokenSupport

Whether the client supports tokens that can overlap each other.

Since 3.16.0

requests	back to summary
private SemanticTokensClientCapabilitiesRequests requests Which requests the client supports and might send to the server. Annotations @NonNull

serverCancelSupport back to summary

serverCancelSupport	back to summary
private Boolean serverCancelSupport Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`. If a server does, the client needs to retrigger the request. Since 3.17.0

private Boolean serverCancelSupport

Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning ResponseErrorCode#ServerCancelled. If a server does, the client needs to retrigger the request.

Since 3.17.0

tokenModifiers back to summary

tokenModifiers	back to summary
private List<String> tokenModifiers The token modifiers that the client supports. See `SemanticTokenModifiers` for allowed values. Annotations @NonNull

private List<String> tokenModifiers

The token modifiers that the client supports.

See SemanticTokenModifiers for allowed values.

Annotations

@NonNull

tokenTypes back to summary

tokenTypes	back to summary
private List<String> tokenTypes The token types that the client supports. See `SemanticTokenTypes` for allowed values. Annotations @NonNull

private List<String> tokenTypes

The token types that the client supports.

See SemanticTokenTypes for allowed values.

Annotations

@NonNull

Constructor Detail

SemanticTokensCapabilities	back to summary
public SemanticTokensCapabilities()

SemanticTokensCapabilities	back to summary
public SemanticTokensCapabilities(final Boolean dynamicRegistration)

SemanticTokensCapabilities	back to summary
public SemanticTokensCapabilities(final SemanticTokensClientCapabilitiesRequests requests, final List<String> tokenTypes, final List<String> tokenModifiers, final List<String> formats)

SemanticTokensCapabilities	back to summary
public SemanticTokensCapabilities(final Boolean dynamicRegistration, final SemanticTokensClientCapabilitiesRequests requests, final List<String> tokenTypes, final List<String> tokenModifiers, final List<String> formats)

Method Detail

equals back to summary

equals	back 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

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

getAugmentsSyntaxTokens back to summary

getAugmentsSyntaxTokens	back to summary
public Boolean getAugmentsSyntaxTokens() Whether the client uses semantic tokens to augment existing syntax tokens. If set to `true` client side created syntax tokens and semantic tokens are both used for colorization. If set to `false` the client only uses the returned semantic tokens for colorization. If the value is omitted then the client behavior is not specified. Since 3.17.0

public Boolean getAugmentsSyntaxTokens()

If the value is omitted then the client behavior is not specified.

Since 3.17.0

getFormats back to summary

getFormats	back to summary
public List<String> getFormats() The formats the client supports. See `TokenFormat` for allowed values. Annotations @NonNull

public List<String> getFormats()

The formats the client supports.

See TokenFormat for allowed values.

Annotations

@NonNull

getMultilineTokenSupport	back to summary
public Boolean getMultilineTokenSupport() Whether the client supports tokens that can span multiple lines. Since 3.16.0

getMultilineTokenSupport

back to summary

public Boolean getMultilineTokenSupport()

Whether the client supports tokens that can span multiple lines.

Since 3.16.0

getOverlappingTokenSupport	back to summary
public Boolean getOverlappingTokenSupport() Whether the client supports tokens that can overlap each other. Since 3.16.0

getOverlappingTokenSupport

back to summary

public Boolean getOverlappingTokenSupport()

Whether the client supports tokens that can overlap each other.

Since 3.16.0

getRequests	back to summary
public SemanticTokensClientCapabilitiesRequests getRequests() Which requests the client supports and might send to the server. Annotations @NonNull

getRequests

back to summary

public SemanticTokensClientCapabilitiesRequests getRequests()

Which requests the client supports and might send to the server.

Annotations

@NonNull

getServerCancelSupport back to summary

getServerCancelSupport	back to summary
public Boolean getServerCancelSupport() Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`. If a server does, the client needs to retrigger the request. Since 3.17.0

public Boolean getServerCancelSupport()

Since 3.17.0

getTokenModifiers back to summary

getTokenModifiers	back to summary
public List<String> getTokenModifiers() The token modifiers that the client supports. See `SemanticTokenModifiers` for allowed values. Annotations @NonNull

public List<String> getTokenModifiers()

The token modifiers that the client supports.

See SemanticTokenModifiers for allowed values.

Annotations

@NonNull

getTokenTypes back to summary

getTokenTypes	back to summary
public List<String> getTokenTypes() The token types that the client supports. See `SemanticTokenTypes` for allowed values. Annotations @NonNull

public List<String> getTokenTypes()

The token types that the client supports.

See SemanticTokenTypes for allowed values.

Annotations

@NonNull

hashCode back to summary

hashCode	back 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

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

setAugmentsSyntaxTokens back to summary

setAugmentsSyntaxTokens	back to summary
public void setAugmentsSyntaxTokens(final Boolean augmentsSyntaxTokens) Whether the client uses semantic tokens to augment existing syntax tokens. If set to `true` client side created syntax tokens and semantic tokens are both used for colorization. If set to `false` the client only uses the returned semantic tokens for colorization. If the value is omitted then the client behavior is not specified. Since 3.17.0

public void setAugmentsSyntaxTokens(final Boolean augmentsSyntaxTokens)

If the value is omitted then the client behavior is not specified.

Since 3.17.0

setFormats back to summary

setFormats	back to summary
public void setFormats(final List<String> formats) The formats the client supports. See `TokenFormat` for allowed values.

public void setFormats(final List<String> formats)

The formats the client supports.

See TokenFormat for allowed values.

setMultilineTokenSupport	back to summary
public void setMultilineTokenSupport(final Boolean multilineTokenSupport) Whether the client supports tokens that can span multiple lines. Since 3.16.0

setMultilineTokenSupport

back to summary

public void setMultilineTokenSupport(final Boolean multilineTokenSupport)

Whether the client supports tokens that can span multiple lines.

Since 3.16.0

setOverlappingTokenSupport	back to summary
public void setOverlappingTokenSupport(final Boolean overlappingTokenSupport) Whether the client supports tokens that can overlap each other. Since 3.16.0

setOverlappingTokenSupport

back to summary

public void setOverlappingTokenSupport(final Boolean overlappingTokenSupport)

Whether the client supports tokens that can overlap each other.

Since 3.16.0

setRequests	back to summary
public void setRequests(final SemanticTokensClientCapabilitiesRequests requests) Which requests the client supports and might send to the server.

setServerCancelSupport back to summary

setServerCancelSupport	back to summary
public void setServerCancelSupport(final Boolean serverCancelSupport) Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning `ResponseErrorCode#ServerCancelled`. If a server does, the client needs to retrigger the request. Since 3.17.0

public void setServerCancelSupport(final Boolean serverCancelSupport)

Since 3.17.0

setTokenModifiers back to summary

setTokenModifiers	back to summary
public void setTokenModifiers(final List<String> tokenModifiers) The token modifiers that the client supports. See `SemanticTokenModifiers` for allowed values.

public void setTokenModifiers(final List<String> tokenModifiers)

The token modifiers that the client supports.

See SemanticTokenModifiers for allowed values.

setTokenTypes back to summary

setTokenTypes	back to summary
public void setTokenTypes(final List<String> tokenTypes) The token types that the client supports. See `SemanticTokenTypes` for allowed values.

public void setTokenTypes(final List<String> tokenTypes)

The token types that the client supports.

See SemanticTokenTypes for allowed values.

toString back to summary

toString	back 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

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

public Class SemanticTokensCapabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail