Package org.eclipse.lsp4j

Class ApplyWorkspaceEditResponse

  • public class ApplyWorkspaceEditResponse
extends java.lang.Object
    The result of the `workspace/applyEdit` request.

    Referred to as ApplyWorkspaceEditResult in the LSP spec.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Integer getFailedChange()
      Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed.
      java.lang.String getFailureReason()
      An optional textual description for why the edit was not applied.
      int hashCode()  
      boolean isApplied()
      Indicates whether the edit was applied or not.
      void setApplied​(boolean applied)
      Indicates whether the edit was applied or not.
      void setFailedChange​(java.lang.Integer failedChange)
      Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed.
      void setFailureReason​(java.lang.String failureReason)
      An optional textual description for why the edit was not applied.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ApplyWorkspaceEditResponse

        public ApplyWorkspaceEditResponse()

      • ApplyWorkspaceEditResponse

        public ApplyWorkspaceEditResponse​(boolean applied)

    • Method Detail

      • isApplied

        public boolean isApplied()
        Indicates whether the edit was applied or not.

      • setApplied

        public void setApplied​(boolean applied)
        Indicates whether the edit was applied or not.

      • getFailureReason

        public java.lang.String getFailureReason()
        An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

      • setFailureReason

        public void setFailureReason​(java.lang.String failureReason)
        An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

      • getFailedChange

        public java.lang.Integer getFailedChange()
        Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a WorkspaceEditCapabilities.failureHandling strategy in its client capabilities.

      • setFailedChange

        public void setFailedChange​(java.lang.Integer failedChange)
        Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a WorkspaceEditCapabilities.failureHandling strategy in its client capabilities.

      • 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