Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.InitializeParams

Modifier and Type	Field and Description
private ClientCapabilities	capabilities The capabilities provided by the client (editor or tool)
private ClientInfo	clientInfo Information about the client Since 3.15.0
private Object	initializationOptions User provided initialization options.
private String	locale The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.
private Integer	processId The process Id of the parent process that started the server.
private String	rootPath Deprecated Use `workspaceFolders` instead. The rootPath of the workspace.
private String	rootUri Deprecated Use `workspaceFolders` instead. The rootUri of the workspace.
private String	trace The initial trace setting.
private Either<String, Integer>	workDoneToken An optional token that a server can use to report work done progress.
private List<WorkspaceFolder>	workspaceFolders The workspace folders configured in the client when the server starts.

Access	Constructor and Description
public	InitializeParams()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public ClientCapabilities	getCapabilities() The capabilities provided by the client (editor or tool)
public ClientInfo	getClientInfo() Information about the client Since 3.15.0
public Object	getInitializationOptions() User provided initialization options.
public String	getLocale() The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.
public Integer	getProcessId() The process Id of the parent process that started the server.
public String	getRootPath() Deprecated Use `workspaceFolders` instead. The rootPath of the workspace.
public String	getRootUri() Deprecated Use `workspaceFolders` instead. The rootUri of the workspace.
public String	getTrace() The initial trace setting.
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 List<WorkspaceFolder>	getWorkspaceFolders() The workspace folders configured in the client when the server starts.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCapabilities(final ClientCapabilities capabilities) The capabilities provided by the client (editor or tool)
public void	setClientInfo(final ClientInfo clientInfo) Information about the client Since 3.15.0
public void	setInitializationOptions(final Object initializationOptions) User provided initialization options.
public void	setLocale(final String locale) The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.
public void	setProcessId(final Integer processId) The process Id of the parent process that started the server.
public void	setRootPath(final String rootPath) Deprecated Use `workspaceFolders` instead. The rootPath of the workspace.
public void	setRootUri(final String rootUri) Deprecated Use `workspaceFolders` instead. The rootUri of the workspace.
public void	setTrace(final String trace) The initial trace setting.
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 void	setWorkspaceFolders(final List<WorkspaceFolder> workspaceFolders) The workspace folders configured in the client when the server starts.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

capabilities	back to summary
private ClientCapabilities capabilities The capabilities provided by the client (editor or tool) Annotations @NonNull

clientInfo	back to summary
private ClientInfo clientInfo Information about the client Since 3.15.0

clientInfo

back to summary

private ClientInfo clientInfo

Information about the client

Since 3.15.0

initializationOptions	back to summary
private Object initializationOptions User provided initialization options. Annotations @JsonAdapter:Factory

locale	back to summary
private String locale The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system. Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag) Since 3.16.0

locale

back to summary

private String locale

The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.

Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)

Since 3.16.0

processId	back to summary
private Integer processId The process Id of the parent process that started the server.

rootPath	back to summary
private String rootPath Deprecated Use `workspaceFolders` instead. The rootPath of the workspace. Is null if no folder is open. Annotations @Deprecated

rootUri	back to summary
private String rootUri Deprecated Use `workspaceFolders` instead. The rootUri of the workspace. Is null if no folder is open. If both `rootPath` and `rootUri` are set, `rootUri` wins. Annotations @Deprecated

trace	back to summary
private String trace The initial trace setting. For values, see `TraceValue`. If omitted trace is disabled (`TraceValue#Off`).

workDoneToken	back to summary
private Either<String, Integer> workDoneToken An optional token that a server can use to report work done progress.

workspaceFolders	back to summary
private List<WorkspaceFolder> workspaceFolders The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured. Since 3.6.0

workspaceFolders

back to summary

private List<WorkspaceFolder> workspaceFolders

The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured.

Since 3.6.0

Constructor Detail

InitializeParams	back to summary
public InitializeParams()

Method Detail

equals back to summary

equals	back 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

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

getCapabilities	back to summary
public ClientCapabilities getCapabilities() The capabilities provided by the client (editor or tool) Annotations @NonNull

getCapabilities

back to summary

public ClientCapabilities getCapabilities()

The capabilities provided by the client (editor or tool)

Annotations

@NonNull

getClientInfo	back to summary
public ClientInfo getClientInfo() Information about the client Since 3.15.0

getClientInfo

back to summary

public ClientInfo getClientInfo()

Information about the client

Since 3.15.0

getInitializationOptions	back to summary
public Object getInitializationOptions() User provided initialization options.

getLocale	back to summary
public String getLocale() The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system. Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag) Since 3.16.0

getLocale

back to summary

public String getLocale()

The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.

Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)

Since 3.16.0

getProcessId	back to summary
public Integer getProcessId() The process Id of the parent process that started the server.

getRootPath back to summary

getRootPath	back to summary
public String getRootPath() Deprecated Use `workspaceFolders` instead. The rootPath of the workspace. Is null if no folder is open. Annotations @Deprecated

public String getRootPath()

Deprecated

Use workspaceFolders instead.

The rootPath of the workspace. Is null if no folder is open.

Annotations

@Deprecated

getRootUri back to summary

getRootUri	back to summary
public String getRootUri() Deprecated Use `workspaceFolders` instead. The rootUri of the workspace. Is null if no folder is open. If both `rootPath` and `rootUri` are set, `rootUri` wins. Annotations @Deprecated

public String getRootUri()

Deprecated

Use workspaceFolders instead.

The rootUri of the workspace. Is null if no folder is open. If both rootPath and `rootUri` are set, `rootUri` wins.

Annotations

@Deprecated

getTrace	back to summary
public String getTrace() The initial trace setting. For values, see `TraceValue`. If omitted trace is disabled (`TraceValue#Off`).

getWorkDoneToken	back 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

getWorkDoneToken

back 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

getWorkspaceFolders	back to summary
public List<WorkspaceFolder> getWorkspaceFolders() The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured. Since 3.6.0

getWorkspaceFolders

back to summary

public List<WorkspaceFolder> getWorkspaceFolders()

Since 3.6.0

hashCode back to summary

hashCode	back 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

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

setCapabilities	back to summary
public void setCapabilities(final ClientCapabilities capabilities) The capabilities provided by the client (editor or tool)

setClientInfo	back to summary
public void setClientInfo(final ClientInfo clientInfo) Information about the client Since 3.15.0

setClientInfo

back to summary

public void setClientInfo(final ClientInfo clientInfo)

Information about the client

Since 3.15.0

setInitializationOptions	back to summary
public void setInitializationOptions(final Object initializationOptions) User provided initialization options.

setLocale	back to summary
public void setLocale(final String locale) The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system. Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag) Since 3.16.0

setLocale

back to summary

public void setLocale(final String locale)

The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.

Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)

Since 3.16.0

setProcessId	back to summary
public void setProcessId(final Integer processId) The process Id of the parent process that started the server.

setRootPath back to summary

setRootPath	back to summary
public void setRootPath(final String rootPath) Deprecated Use `workspaceFolders` instead. The rootPath of the workspace. Is null if no folder is open. Annotations @Deprecated

public void setRootPath(final String rootPath)

Deprecated

Use workspaceFolders instead.

The rootPath of the workspace. Is null if no folder is open.

Annotations

@Deprecated

setRootUri back to summary

setRootUri	back to summary
public void setRootUri(final String rootUri) Deprecated Use `workspaceFolders` instead. The rootUri of the workspace. Is null if no folder is open. If both `rootPath` and `rootUri` are set, `rootUri` wins. Annotations @Deprecated

public void setRootUri(final String rootUri)

Deprecated

Use workspaceFolders instead.

The rootUri of the workspace. Is null if no folder is open. If both rootPath and `rootUri` are set, `rootUri` wins.

Annotations

@Deprecated

setTrace	back to summary
public void setTrace(final String trace) The initial trace setting. For values, see `TraceValue`. If omitted trace is disabled (`TraceValue#Off`).

setWorkDoneToken	back 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.

setWorkDoneToken

back 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.

setWorkDoneToken	back to summary
public void setWorkDoneToken(final String workDoneToken)

setWorkDoneToken	back to summary
public void setWorkDoneToken(final Integer workDoneToken)

setWorkspaceFolders	back to summary
public void setWorkspaceFolders(final List<WorkspaceFolder> workspaceFolders) The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured. Since 3.6.0

setWorkspaceFolders

back to summary

public void setWorkspaceFolders(final List<WorkspaceFolder> workspaceFolders)

Since 3.6.0

toString back to summary

toString	back 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

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

public Class InitializeParams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail