c

scala.meta.internal.metals.clients.language

ConfiguredLanguageClient

final class ConfiguredLanguageClient extends DelegatingLanguageClient

Delegates requests/notifications to the underlying language client according to the user configuration.

This wrapper class manages differences in how editors interpret LSP endpoints slightly differently, especially the window/{logMessage,showMessage} notifications. For example, with vim-lsc the messages from window/logMessage are always visible in the UI while in VS Code the logs are hidden by default.

Linear Supertypes
DelegatingLanguageClient, MetalsLanguageClient, DecorationClient, TreeViewClient, LanguageClient, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfiguredLanguageClient
  2. DelegatingLanguageClient
  3. MetalsLanguageClient
  4. DecorationClient
  5. TreeViewClient
  6. LanguageClient
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConfiguredLanguageClient(initial: MetalsLanguageClient, clientConfig: ClientConfiguration, service: WorkspaceLspService)(implicit ec: ExecutionContext)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def applyEdit(params: ApplyWorkspaceEditParams): CompletableFuture[ApplyWorkspaceEditResponse]
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def configuration(configurationParams: ConfigurationParams): CompletableFuture[java.util.List[AnyRef]]
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  8. def createProgress(params: WorkDoneProgressCreateParams): CompletableFuture[Void]
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient → LanguageClient
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def logMessage(message: MessageParams): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → LanguageClient
  15. def logTrace(arg0: LogTraceParams): Unit
    Definition Classes
    LanguageClient
    Annotations
    @JsonNotification()
  16. def metalsExecuteClientCommand(params: ExecuteCommandParams): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  17. final def metalsInputBox(params: MetalsInputBoxParams): CompletableFuture[Option[MetalsInputBoxResult]]

    Opens an input box to ask the user for input.

    Opens an input box to ask the user for input.

    returns

    the user provided input or None if request was cancelled. The future can be cancelled, meaning the input box should be dismissed in the editor.

    Definition Classes
    MetalsLanguageClient
  18. def metalsPublishDecorations(params: PublishDecorationsParams): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → DecorationClient
  19. final def metalsQuickPick(params: MetalsQuickPickParams): CompletableFuture[Option[MetalsQuickPickResult]]

    Opens an menu to ask the user to pick one of the suggested options.

    Opens an menu to ask the user to pick one of the suggested options.

    returns

    the user provided pick or None if request was cancelled. The future can be cancelled, meaning the input box should be dismissed in the editor.

    Definition Classes
    MetalsLanguageClient
  20. def metalsStatus(params: MetalsStatusParams): Unit

    Display message in the editor "status bar", which should be displayed somewhere alongside the buffer.

    Display message in the editor "status bar", which should be displayed somewhere alongside the buffer.

    The status bar should always be visible to the user.

    - VS Code: https://code.visualstudio.com/docs/extensionAPI/vscode-api#StatusBarItem

    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  21. def metalsTreeViewDidChange(params: TreeViewDidChangeParams): Unit
    Definition Classes
    DelegatingLanguageClient → TreeViewClient
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  25. def notifyProgress(params: ProgressParams): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient → LanguageClient
  26. def publishDiagnostics(diagnostics: PublishDiagnosticsParams): Unit
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  27. def rawMetalsInputBox(params: MetalsInputBoxParams): CompletableFuture[RawMetalsInputBoxResult]

    Opens an input box to ask the user for input.

    Opens an input box to ask the user for input. This method is used to deal with gson and existing extension protocol.

    returns

    the user provided input.

    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  28. def rawMetalsQuickPick(params: MetalsQuickPickParams): CompletableFuture[RawMetalsQuickPickResult]

    Opens an menu to ask the user to pick one of the suggested options.

    Opens an menu to ask the user to pick one of the suggested options. This method is used to deal with gson and existing extension protocol.

    returns

    the user provided pick.

    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  29. def refreshCodeLenses(): CompletableFuture[Void]
    Definition Classes
    LanguageClient
    Annotations
    @JsonRequest()
  30. def refreshDiagnostics(): CompletableFuture[Void]
    Definition Classes
    LanguageClient
    Annotations
    @JsonRequest()
  31. def refreshInlayHints(): CompletableFuture[Void]
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → LanguageClient
  32. def refreshInlineValues(): CompletableFuture[Void]
    Definition Classes
    LanguageClient
    Annotations
    @JsonRequest()
  33. def refreshModel(): CompletableFuture[Unit]
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  34. def refreshSemanticTokens(): CompletableFuture[Void]
    Definition Classes
    ConfiguredLanguageClient → LanguageClient
  35. def registerCapability(params: RegistrationParams): CompletableFuture[Void]
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  36. def showDocument(arg0: ShowDocumentParams): CompletableFuture[ShowDocumentResult]
    Definition Classes
    LanguageClient
    Annotations
    @JsonRequest()
  37. def showMessage(params: MessageParams): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → LanguageClient
  38. final def showMessage(messageType: MessageType, message: String): Unit
    Definition Classes
    MetalsLanguageClient
  39. def showMessageRequest(params: ShowMessageRequestParams): CompletableFuture[MessageActionItem]
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → LanguageClient
  40. def shutdown(): Unit
    Definition Classes
    ConfiguredLanguageClient → DelegatingLanguageClient → MetalsLanguageClient
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def telemetryEvent(value: Any): Unit
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. var underlying: MetalsLanguageClient
    Definition Classes
    DelegatingLanguageClient
  45. def unregisterCapability(params: UnregistrationParams): CompletableFuture[Void]
    Definition Classes
    DelegatingLanguageClient → LanguageClient
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. def workspaceFolders(): CompletableFuture[java.util.List[WorkspaceFolder]]
    Definition Classes
    LanguageClient
    Annotations
    @JsonRequest()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from DelegatingLanguageClient

Inherited from MetalsLanguageClient

Inherited from DecorationClient

Inherited from TreeViewClient

Inherited from LanguageClient

Inherited from AnyRef

Inherited from Any

Ungrouped