Package org.eclipse.lsp4j

Class GeneralClientCapabilities

  • public class GeneralClientCapabilities
extends java.lang.Object
    General client capabilities.

    Since 3.16.0

    • Constructor Detail

      • GeneralClientCapabilities

        public GeneralClientCapabilities()

    • Method Detail

      • getRegularExpressions

        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

        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

        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

        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

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object