org.eclipse.lsp4j

Class GeneralClientCapabilities

java.lang.Object

org.eclipse.lsp4j.GeneralClientCapabilities

public class GeneralClientCapabilities
extends java.lang.Object

General client capabilities.

Since 3.16.0

Constructor Summary

Constructors

Constructor and Description
GeneralClientCapabilities()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
MarkdownCapabilities	getMarkdown() Client capabilities specific to the client's markdown parser.
java.util.List<java.lang.String>	getPositionEncodings() The position encodings supported by the client.
RegularExpressionsCapabilities	getRegularExpressions() Client capabilities specific to regular expressions.
StaleRequestCapabilities	getStaleRequestSupport() Client capability that signals how the client handles stale requests (e.g.
int	hashCode()
void	setMarkdown(MarkdownCapabilities markdown) Client capabilities specific to the client's markdown parser.
void	setPositionEncodings(java.util.List<java.lang.String> positionEncodings) The position encodings supported by the client.
void	setRegularExpressions(RegularExpressionsCapabilities regularExpressions) Client capabilities specific to regular expressions.
void	setStaleRequestSupport(StaleRequestCapabilities staleRequestSupport) Client capability that signals how the client handles stale requests (e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralClientCapabilities

public GeneralClientCapabilities()

Method Detail

getRegularExpressions

@Pure
public RegularExpressionsCapabilities getRegularExpressions()

Client capabilities specific to regular expressions.

Since 3.16.0

setRegularExpressions

public void setRegularExpressions(RegularExpressionsCapabilities regularExpressions)

Client capabilities specific to regular expressions.

Since 3.16.0

getMarkdown

@Pure
public MarkdownCapabilities getMarkdown()

Client capabilities specific to the client's markdown parser.

Since 3.16.0

setMarkdown

public void setMarkdown(MarkdownCapabilities markdown)

Client capabilities specific to the client's markdown parser.

Since 3.16.0

getStaleRequestSupport

@Pure
public StaleRequestCapabilities getStaleRequestSupport()

Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).

Since 3.17.0

setStaleRequestSupport

public void setStaleRequestSupport(StaleRequestCapabilities staleRequestSupport)

Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).

Since 3.17.0

getPositionEncodings

@Pure
public java.util.List<java.lang.String> getPositionEncodings()

The position encodings supported by the client. Client and server have to agree on the same position encoding to ensure that offsets (e.g. character position in a line) are interpreted the same on both side.

To keep the protocol backwards compatible the following applies: if the value 'utf-16' is missing from the array of position encodings servers can assume that the client supports UTF-16. UTF-16 is therefore a mandatory encoding.

If omitted it defaults to [PositionEncodingKind.UTF16].

Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.

See PositionEncodingKind for some predefined position encoding kinds.

Since 3.17.0

setPositionEncodings

public void setPositionEncodings(java.util.List<java.lang.String> positionEncodings)

The position encodings supported by the client. Client and server have to agree on the same position encoding to ensure that offsets (e.g. character position in a line) are interpreted the same on both side.

To keep the protocol backwards compatible the following applies: if the value 'utf-16' is missing from the array of position encodings servers can assume that the client supports UTF-16. UTF-16 is therefore a mandatory encoding.

If omitted it defaults to [PositionEncodingKind.UTF16].

Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.

See PositionEncodingKind for some predefined position encoding kinds.

Since 3.17.0

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object