Package org.eclipse.lsp4j

Class ExecuteCommandParams

  • All Implemented Interfaces:
    WorkDoneProgressParams
    public class ExecuteCommandParams
extends java.lang.Object
implements WorkDoneProgressParams
    The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server. In most cases the server creates a WorkspaceEdit structure and applies the changes to the workspace using the request workspace/applyEdit which is sent from the server to the client.

    • Constructor Summary

      Constructors 
      Constructor Description
      ExecuteCommandParams()  
      ExecuteCommandParams​(java.lang.String command, java.util.List<java.lang.Object> arguments)  
      ExecuteCommandParams​(java.lang.String command, java.util.List<java.lang.Object> arguments, org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> workDoneToken)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.util.List<java.lang.Object> getArguments()
      Arguments that the command should be invoked with.
      java.lang.String getCommand()
      The identifier of the actual command handler.
      org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> getWorkDoneToken()
      An optional token that a server can use to report work done progress.
      int hashCode()  
      void setArguments​(java.util.List<java.lang.Object> arguments)
      Arguments that the command should be invoked with.
      void setCommand​(java.lang.String command)
      The identifier of the actual command handler.
      void setWorkDoneToken​(java.lang.Integer workDoneToken)  
      void setWorkDoneToken​(java.lang.String workDoneToken)  
      void setWorkDoneToken​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> workDoneToken)
      An optional token that a server can use to report work done progress.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ExecuteCommandParams

        public ExecuteCommandParams()

      • ExecuteCommandParams

        public ExecuteCommandParams​(java.lang.String command,
                            java.util.List<java.lang.Object> arguments)

      • ExecuteCommandParams

        public ExecuteCommandParams​(java.lang.String command,
                            java.util.List<java.lang.Object> arguments,
                            org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> workDoneToken)

    • Method Detail

      • getWorkDoneToken

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> getWorkDoneToken()
        An optional token that a server can use to report work done progress.
        Specified by:
        getWorkDoneToken in interface WorkDoneProgressParams

      • setWorkDoneToken

        public void setWorkDoneToken​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​java.lang.Integer> workDoneToken)
        An optional token that a server can use to report work done progress.
        Specified by:
        setWorkDoneToken in interface WorkDoneProgressParams

      • setWorkDoneToken

        public void setWorkDoneToken​(java.lang.String workDoneToken)

      • setWorkDoneToken

        public void setWorkDoneToken​(java.lang.Integer workDoneToken)

      • getCommand

        public java.lang.String getCommand()
        The identifier of the actual command handler.

      • setCommand

        public void setCommand​(java.lang.String command)
        The identifier of the actual command handler.

      • getArguments

        public java.util.List<java.lang.Object> getArguments()
        Arguments that the command should be invoked with. The arguments are typically specified when a command is returned from the server to the client. Example requests that return a command are textDocument/codeAction or textDocument/codeLens.

      • setArguments

        public void setArguments​(java.util.List<java.lang.Object> arguments)
        Arguments that the command should be invoked with. The arguments are typically specified when a command is returned from the server to the client. Example requests that return a command are textDocument/codeAction or textDocument/codeLens.

      • 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