Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.GeneralClientCapabilities

Modifier and Type	Field and Description
private MarkdownCapabilities	markdown Client capabilities specific to the client's markdown parser.
private List<String>	positionEncodings The position encodings supported by the client.
private RegularExpressionsCapabilities	regularExpressions Client capabilities specific to regular expressions.
private 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).

Access	Constructor and Description
public	GeneralClientCapabilities()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public MarkdownCapabilities	getMarkdown() Client capabilities specific to the client's markdown parser.
public List<String>	getPositionEncodings() The position encodings supported by the client.
public RegularExpressionsCapabilities	getRegularExpressions() Client capabilities specific to regular expressions.
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).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setMarkdown(final MarkdownCapabilities markdown) Client capabilities specific to the client's markdown parser.
public void	setPositionEncodings(final List<String> positionEncodings) The position encodings supported by the client.
public void	setRegularExpressions(final RegularExpressionsCapabilities regularExpressions) Client capabilities specific to regular expressions.
public void	setStaleRequestSupport(final 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).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

markdown	back to summary
private MarkdownCapabilities markdown Client capabilities specific to the client's markdown parser. Since 3.16.0

positionEncodings	back to summary
private List<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

regularExpressions	back to summary
private RegularExpressionsCapabilities regularExpressions Client capabilities specific to regular expressions. Since 3.16.0

staleRequestSupport	back to summary
private 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

GeneralClientCapabilities	back to summary
public GeneralClientCapabilities()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.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 java.lang.Object.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

getMarkdown	back to summary
public MarkdownCapabilities getMarkdown() Client capabilities specific to the client's markdown parser. Since 3.16.0

getMarkdown

back to summary

public MarkdownCapabilities getMarkdown()

Client capabilities specific to the client's markdown parser.

Since 3.16.0

getPositionEncodings back to summary

getPositionEncodings	back to summary
public List<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

public List<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

getRegularExpressions	back to summary
public RegularExpressionsCapabilities getRegularExpressions() Client capabilities specific to regular expressions. Since 3.16.0

getRegularExpressions

back to summary

public RegularExpressionsCapabilities getRegularExpressions()

Client capabilities specific to regular expressions.

Since 3.16.0

getStaleRequestSupport	back to summary
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

getStaleRequestSupport

back to summary

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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.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 java.lang.Object.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

setMarkdown	back to summary
public void setMarkdown(final MarkdownCapabilities markdown) Client capabilities specific to the client's markdown parser. Since 3.16.0

setMarkdown

back to summary

public void setMarkdown(final MarkdownCapabilities markdown)

Client capabilities specific to the client's markdown parser.

Since 3.16.0

setPositionEncodings back to summary

setPositionEncodings	back to summary
public void setPositionEncodings(final List<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

public void setPositionEncodings(final List<String> positionEncodings)

If omitted it defaults to [PositionEncodingKind#UTF16].

See PositionEncodingKind for some predefined position encoding kinds.

Since 3.17.0

setRegularExpressions	back to summary
public void setRegularExpressions(final RegularExpressionsCapabilities regularExpressions) Client capabilities specific to regular expressions. Since 3.16.0

setRegularExpressions

back to summary

public void setRegularExpressions(final RegularExpressionsCapabilities regularExpressions)

Client capabilities specific to regular expressions.

Since 3.16.0

setStaleRequestSupport	back to summary
public void setStaleRequestSupport(final 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

setStaleRequestSupport

back to summary

public void setStaleRequestSupport(final 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

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.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 java.lang.Object.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 GeneralClientCapabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail