Package org.eclipse.lsp4j

Class SemanticTokensCapabilities

java.lang.Object

org.eclipse.lsp4j.DynamicRegistrationCapabilities

org.eclipse.lsp4j.SemanticTokensCapabilities

public class SemanticTokensCapabilities
extends DynamicRegistrationCapabilities

Since 3.16.0

Constructor Summary

Constructors

Constructor	Description
SemanticTokensCapabilities()
SemanticTokensCapabilities(java.lang.Boolean dynamicRegistration)
SemanticTokensCapabilities(java.lang.Boolean dynamicRegistration, SemanticTokensClientCapabilitiesRequests requests, java.util.List<java.lang.String> tokenTypes, java.util.List<java.lang.String> tokenModifiers, java.util.List<java.lang.String> formats)
SemanticTokensCapabilities(SemanticTokensClientCapabilitiesRequests requests, java.util.List<java.lang.String> tokenTypes, java.util.List<java.lang.String> tokenModifiers, java.util.List<java.lang.String> formats)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getAugmentsSyntaxTokens()	Whether the client uses semantic tokens to augment existing syntax tokens.
java.util.List<java.lang.String>	getFormats()	The formats the client supports.
java.lang.Boolean	getMultilineTokenSupport()	Whether the client supports tokens that can span multiple lines.
java.lang.Boolean	getOverlappingTokenSupport()	Whether the client supports tokens that can overlap each other.
SemanticTokensClientCapabilitiesRequests	getRequests()	Which requests the client supports and might send to the server.
java.lang.Boolean	getServerCancelSupport()	Whether the client allows the server to actively cancel a semantic token request, e.g.
java.util.List<java.lang.String>	getTokenModifiers()	The token modifiers that the client supports.
java.util.List<java.lang.String>	getTokenTypes()	The token types that the client supports.
int	hashCode()
void	setAugmentsSyntaxTokens(java.lang.Boolean augmentsSyntaxTokens)	Whether the client uses semantic tokens to augment existing syntax tokens.
void	setFormats(java.util.List<java.lang.String> formats)	The formats the client supports.
void	setMultilineTokenSupport(java.lang.Boolean multilineTokenSupport)	Whether the client supports tokens that can span multiple lines.
void	setOverlappingTokenSupport(java.lang.Boolean overlappingTokenSupport)	Whether the client supports tokens that can overlap each other.
void	setRequests(SemanticTokensClientCapabilitiesRequests requests)	Which requests the client supports and might send to the server.
void	setServerCancelSupport(java.lang.Boolean serverCancelSupport)	Whether the client allows the server to actively cancel a semantic token request, e.g.
void	setTokenModifiers(java.util.List<java.lang.String> tokenModifiers)	The token modifiers that the client supports.
void	setTokenTypes(java.util.List<java.lang.String> tokenTypes)	The token types that the client supports.
java.lang.String	toString()

Methods inherited from class org.eclipse.lsp4j.DynamicRegistrationCapabilities

getDynamicRegistration, setDynamicRegistration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SemanticTokensCapabilities

public SemanticTokensCapabilities()

SemanticTokensCapabilities

public SemanticTokensCapabilities(java.lang.Boolean dynamicRegistration)

SemanticTokensCapabilities

public SemanticTokensCapabilities(SemanticTokensClientCapabilitiesRequests requests,
                                  java.util.List<java.lang.String> tokenTypes,
                                  java.util.List<java.lang.String> tokenModifiers,
                                  java.util.List<java.lang.String> formats)

SemanticTokensCapabilities

public SemanticTokensCapabilities(java.lang.Boolean dynamicRegistration,
                                  SemanticTokensClientCapabilitiesRequests requests,
                                  java.util.List<java.lang.String> tokenTypes,
                                  java.util.List<java.lang.String> tokenModifiers,
                                  java.util.List<java.lang.String> formats)

Method Detail

getRequests

public SemanticTokensClientCapabilitiesRequests getRequests()

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

setRequests

public void setRequests(SemanticTokensClientCapabilitiesRequests requests)

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

getTokenTypes

public java.util.List<java.lang.String> getTokenTypes()

The token types that the client supports.

See SemanticTokenTypes for allowed values.

setTokenTypes

public void setTokenTypes(java.util.List<java.lang.String> tokenTypes)

The token types that the client supports.

See SemanticTokenTypes for allowed values.

getTokenModifiers

public java.util.List<java.lang.String> getTokenModifiers()

The token modifiers that the client supports.

See SemanticTokenModifiers for allowed values.

setTokenModifiers

public void setTokenModifiers(java.util.List<java.lang.String> tokenModifiers)

The token modifiers that the client supports.

See SemanticTokenModifiers for allowed values.

getFormats

public java.util.List<java.lang.String> getFormats()

The formats the client supports.

See TokenFormat for allowed values.

setFormats

public void setFormats(java.util.List<java.lang.String> formats)

The formats the client supports.

See TokenFormat for allowed values.

getOverlappingTokenSupport

public java.lang.Boolean getOverlappingTokenSupport()

Whether the client supports tokens that can overlap each other.

Since 3.16.0

setOverlappingTokenSupport

public void setOverlappingTokenSupport(java.lang.Boolean overlappingTokenSupport)

Whether the client supports tokens that can overlap each other.

Since 3.16.0

getMultilineTokenSupport

public java.lang.Boolean getMultilineTokenSupport()

Whether the client supports tokens that can span multiple lines.

Since 3.16.0

setMultilineTokenSupport

public void setMultilineTokenSupport(java.lang.Boolean multilineTokenSupport)

Whether the client supports tokens that can span multiple lines.

Since 3.16.0

getServerCancelSupport

public java.lang.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

setServerCancelSupport

public void setServerCancelSupport(java.lang.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

getAugmentsSyntaxTokens

public java.lang.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

setAugmentsSyntaxTokens

public void setAugmentsSyntaxTokens(java.lang.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

toString

public java.lang.String toString()

Overrides:

toString in class DynamicRegistrationCapabilities

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DynamicRegistrationCapabilities

hashCode

public int hashCode()

Overrides:

hashCode in class DynamicRegistrationCapabilities