Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class ExecuteCommandParams

extends Object
implements WorkDoneProgressParams
Class Inheritance
All Implemented Interfaces
org.eclipse.lsp4j.WorkDoneProgressParams
Annotations
@SuppressWarnings:all
Imports
java.util.List, org.eclipse.lsp4j.jsonrpc.messages.Either, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

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.

Field Summary

Modifier and TypeField and Description
private List<Object>
arguments

Arguments that the command should be invoked with.

private String
command

The identifier of the actual command handler.

private Either<String, Integer>
workDoneToken

An optional token that a server can use to report work done progress.

Constructor Summary

AccessConstructor and Description
public
public
ExecuteCommandParams(final String command, final List<Object> arguments)

public
ExecuteCommandParams(final String command, final List<Object> arguments, final Either<String, Integer> workDoneToken)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public List<Object>
getArguments()

Arguments that the command should be invoked with.

public String
getCommand()

The identifier of the actual command handler.

public Either<String, Integer>
getWorkDoneToken()

Implements org.eclipse.lsp4j.WorkDoneProgressParams.getWorkDoneToken.

An optional token that a server can use to report work done progress.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setArguments(final List<Object> arguments)

Arguments that the command should be invoked with.

public void
setCommand(final String command)

The identifier of the actual command handler.

public void
setWorkDoneToken(final Either<String, Integer> workDoneToken)

Implements org.eclipse.lsp4j.WorkDoneProgressParams.setWorkDoneToken.

An optional token that a server can use to report work done progress.

public void
setWorkDoneToken(final String workDoneToken)

public void
setWorkDoneToken(final Integer workDoneToken)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

argumentsback to summary
private List<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.

commandback to summary
private String command

The identifier of the actual command handler.

Annotations
@NonNull
workDoneTokenback to summary
private Either<String, Integer> workDoneToken

An optional token that a server can use to report work done progress.

Constructor Detail

ExecuteCommandParamsback to summary
public ExecuteCommandParams()
ExecuteCommandParamsback to summary
public ExecuteCommandParams(final String command, final List<Object> arguments)
ExecuteCommandParamsback to summary
public ExecuteCommandParams(final String command, final List<Object> arguments, final Either<String, Integer> workDoneToken)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getArgumentsback to summary
public List<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.

getCommandback to summary
public String getCommand()

The identifier of the actual command handler.

Annotations
@NonNull
getWorkDoneTokenback to summary
public Either<String, Integer> getWorkDoneToken()

Implements org.eclipse.lsp4j.WorkDoneProgressParams.getWorkDoneToken.

An optional token that a server can use to report work done progress.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
setArgumentsback to summary
public void setArguments(final List<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.

setCommandback to summary
public void setCommand(final String command)

The identifier of the actual command handler.

setWorkDoneTokenback to summary
public void setWorkDoneToken(final Either<String, Integer> workDoneToken)

Implements org.eclipse.lsp4j.WorkDoneProgressParams.setWorkDoneToken.

An optional token that a server can use to report work done progress.

setWorkDoneTokenback to summary
public void setWorkDoneToken(final String workDoneToken)
setWorkDoneTokenback to summary
public void setWorkDoneToken(final Integer workDoneToken)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override