Packages

t

org.mulesoft.language.client.client

IClientConnection

trait IClientConnection extends ILogger

Connection for Scala and Java clients

Linear Supertypes
ILogger, AnyRef, Any
Known Subclasses
AbstractClientConnection
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IClientConnection
  2. ILogger
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def allAvailableActions(): Future[Seq[IExecutableAction]]

    Calculates the list of all available actions.

  2. abstract def calculateEditorContextActions(uri: String, position: Int): Future[Seq[IExecutableAction]]

    Calculates the list of executable actions avilable in the current context.

    Calculates the list of executable actions avilable in the current context.

    uri

    - document uri.

    position

    - optional position in the document. If not provided, the last reported by positionChanged method will be used.

  3. abstract def changeDetailValue(uri: String, position: Int, itemID: String, value: AnyVal): Future[Seq[IChangedDocument]]

    Changes value of details item.

    Changes value of details item.

    uri

    - uri of the document to change

    position

    - position of the value to change

    itemID

    - identifier of the value to change

    value

    - new value

  4. abstract def debug(message: String, component: String, subcomponent: String): Unit

    Logs a DEBUG severity message.

    Logs a DEBUG severity message.

    message

    - message text

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger
  5. abstract def debugDetail(message: String, component: String, subcomponent: String): Unit

    Logs a DEBUG_DETAIL severity message.

    Logs a DEBUG_DETAIL severity message.

    message

    - message text

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger
  6. abstract def debugOverview(message: String, component: String, subcomponent: String): Unit

    Logs a DEBUG_OVERVIEW severity message.

    Logs a DEBUG_OVERVIEW severity message.

    message

    - message text

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger
  7. abstract def documentChanged(document: IChangedDocument): Unit

    Notifies the server that document is changed.

  8. abstract def documentClosed(uri: String): Unit

    Notified the server that document is closed.

  9. abstract def documentOpened(document: IOpenedDocument): Unit

    Notifies the server that document is opened.

  10. abstract def error(message: String, component: String, subcomponent: String): Unit

    Logs an ERROR severity message.

    Logs an ERROR severity message.

    message

    - message text

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger
  11. abstract def executeContextAction(uri: String, action: IExecutableAction, position: Int): Future[Seq[IChangedDocument]]

    Executes the specified action.

    Executes the specified action. If action has UI, causes a consequent server->client UI message resulting in onDisplayActionUI listener call.

    uri

    - document uri

    action

    - action to execute.

    position

    - optional position in the document. If not provided, the last reported by positionChanged method will be used.

  12. abstract def executeContextActionByID(uri: String, actionID: String, position: Int): Future[Seq[IChangedDocument]]

    Executes the specified action.

    Executes the specified action. If action has UI, causes a consequent server->client UI message resulting in onDisplayActionUI listener call.

    uri

    - document uri

    actionID

    - actionID to execute.

    position

    - optional position in the document. If not provided, the last reported by positionChanged method will be used.

  13. abstract def executeDetailsAction(uri: String, actionID: String, position: Int): Future[Seq[IChangedDocument]]

    Executes the specified details action.

    Executes the specified details action.

    uri

    - document uri

    actionID

    - ID of the action to execute.

    position

    - optional position in the document. If not provided, the last reported by positionChanged method will be used.

  14. abstract def findReferences(uri: String, position: Int): Future[Seq[ILocation]]

    Requests server for the positions of the references of the element defined at the given document position.

    Requests server for the positions of the references of the element defined at the given document position.

    uri

    - document uri

    position

    - position in the document

  15. abstract def getDetails(uri: String, position: Int): Future[IDetailsItem]

    Requests server for the document+position details.

  16. abstract def getLatestVersion(uri: String): Future[Int]

    Gets latest document version.

  17. abstract def getStructure(uri: String): Future[Map[String, StructureNodeJSON]]

    Requests server for the document structure.

  18. abstract def getSuggestions(uri: String, position: Int): Future[Seq[ISuggestion]]

    Requests server for the suggestions.

    Requests server for the suggestions.

    uri

    - document uri

    position

    - offset in the document, starting from 0

  19. abstract def log(message: String, severity: common.logger.MessageSeverity.Value, component: String, subcomponent: String): Unit

    Logs a message

    Logs a message

    message

    - message text

    severity

    - message severity

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger
  20. abstract def markOccurrences(uri: String, position: Int): Future[Seq[IRange]]

    Requests server for the occurrences of the element defined at the given document position.

    Requests server for the occurrences of the element defined at the given document position.

    uri

    - document uri

    position

    - position in the document

  21. abstract def onContent(listener: (String) ⇒ Future[String], unsubscribe: Boolean = false): Unit

    Listens to the server requests for file contents, answering what contents file has.

  22. abstract def onDetailsReport(listener: (IDetailsReport) ⇒ Unit, unsubscribe: Boolean = false): Unit

    Report from the server that the new details are calculated for particular document and position.

  23. abstract def onDisplayActionUI(listener: (IUIDisplayRequest) ⇒ Future[Any], unsubscribe: Boolean = false): Unit

    Adds a listener to display action UI.

    Adds a listener to display action UI.

    listener

    - accepts UI display request, should result in a promise returning final UI state to be transferred to the server.

  24. abstract def onExists(listener: (String) ⇒ Future[Boolean], unsubscribe: Boolean = false): Unit

    Listens to the server requests for FS path existence, answering whether a particular path exists on FS.

  25. abstract def onIsDirectory(listener: (String) ⇒ Future[Boolean], unsubscribe: Boolean = false): Unit

    Listens to the server requests for directory check, answering whether a particular path is a directory.

  26. abstract def onReadDir(listener: (String) ⇒ Future[Seq[String]], unsubscribe: Boolean = false): Unit

    Listens to the server requests for directory contents, answering with a list of files in a directory.

  27. abstract def onStructureReport(listener: (IStructureReport) ⇒ Unit, unsubscribe: Boolean = false): Unit

    Instead of calling getStructure to get immediate structure report for the document, this method allows to launch to the new structure reports when those are available.

  28. abstract def onValidationReport(listener: (IValidationReport) ⇒ Unit, unsubscribe: Boolean = false): Unit

    Adds a listener for validation report coming from the server.

  29. abstract def openDeclaration(uri: String, position: Int): Future[Seq[ILocation]]

    Requests server for the positions of the declaration of the element defined at the given document position.

    Requests server for the positions of the declaration of the element defined at the given document position.

    uri

    - document uri

    position

    - position in the document

  30. abstract def positionChanged(uri: String, position: Int): Unit

    Reports to the server the position (cursor) change on the client.

    Reports to the server the position (cursor) change on the client.

    uri

    - document uri.

    position

    - curtsor position, starting from 0.

  31. abstract def rename(uri: String, position: Int, newName: String): Future[Seq[IChangedDocument]]

    Requests server for rename of the element at the given document position.

    Requests server for rename of the element at the given document position.

    uri

    - document uri

    position

    - position in the document

  32. abstract def setLoggerConfiguration(loggerSettings: ILoggerSettings): Unit

    Sets logger configuration, both for the server and for the client.

    Sets logger configuration, both for the server and for the client.

    Definition Classes
    ILogger
  33. abstract def setServerConfiguration(serverSettings: IServerConfiguration): Unit

    Sets server configuration.

  34. abstract def stop(): Unit

    Stops the server.

  35. abstract def warning(message: String, component: String, subcomponent: String): Unit

    Logs a WARNING severity message.

    Logs a WARNING severity message.

    message

    - message text

    component

    - component name

    subcomponent

    - sub-component name

    Definition Classes
    ILogger

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ILogger

Inherited from AnyRef

Inherited from Any

Ungrouped