InitializeParams (org.eclipse.lsp4j 0.15.0 API)

java.lang.Object
- org.eclipse.lsp4j.InitializeParams

All Implemented Interfaces:

WorkDoneProgressParams
```
public class InitializeParams
extends java.lang.Object
implements WorkDoneProgressParams
```
The initialize request is sent as the first request from the client to the server.

Constructor Summary

Constructors
Constructor and Description

InitializeParams()

Constructors
Constructor and Description
`InitializeParams()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`ClientCapabilities`	`getCapabilities()` The capabilities provided by the client (editor or tool)
`ClientInfo`	`getClientInfo()` Information about the client
`java.lang.Object`	`getInitializationOptions()` User provided initialization options.
`java.lang.String`	`getLocale()` The locale the client is currently showing the user interface in.
`java.lang.Integer`	`getProcessId()` The process Id of the parent process that started the server.
`java.lang.String`	`getRootPath()` Deprecated. Use `workspaceFolders` instead.
`java.lang.String`	`getRootUri()` Deprecated. Use `workspaceFolders` instead.
`java.lang.String`	`getTrace()` The initial trace setting.
`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.
`java.util.List<WorkspaceFolder>`	`getWorkspaceFolders()` The workspace folders configured in the client when the server starts.
`int`	`hashCode()`
`void`	`setCapabilities(ClientCapabilities capabilities)` The capabilities provided by the client (editor or tool)
`void`	`setClientInfo(ClientInfo clientInfo)` Information about the client
`void`	`setInitializationOptions(java.lang.Object initializationOptions)` User provided initialization options.
`void`	`setLocale(java.lang.String locale)` The locale the client is currently showing the user interface in.
`void`	`setProcessId(java.lang.Integer processId)` The process Id of the parent process that started the server.
`void`	`setRootPath(java.lang.String rootPath)` Deprecated. Use `workspaceFolders` instead.
`void`	`setRootUri(java.lang.String rootUri)` Deprecated. Use `workspaceFolders` instead.
`void`	`setTrace(java.lang.String trace)` The initial trace setting.
`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.
`void`	`setWorkDoneToken(java.lang.Integer workDoneToken)`
`void`	`setWorkDoneToken(java.lang.String workDoneToken)`
`void`	`setWorkspaceFolders(java.util.List<WorkspaceFolder> workspaceFolders)` The workspace folders configured in the client when the server starts.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InitializeParams
```
public InitializeParams()
```
- Method Detail
  - getWorkDoneToken
```
@Pure
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)
```
  - getProcessId
```
@Pure
public java.lang.Integer getProcessId()
```
    The process Id of the parent process that started the server.
  - setProcessId
```
public void setProcessId(java.lang.Integer processId)
```
    The process Id of the parent process that started the server.
  - getRootPath
```
@Pure
 @Deprecated
public java.lang.String getRootPath()
```
    Deprecated. Use workspaceFolders instead.
    
    The rootPath of the workspace. Is null if no folder is open.
  - setRootPath
```
@Deprecated
public void setRootPath(java.lang.String rootPath)
```
    Deprecated. Use workspaceFolders instead.
    
    The rootPath of the workspace. Is null if no folder is open.
  - getRootUri
```
@Pure
 @Deprecated
public java.lang.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.
  - setRootUri
```
@Deprecated
public void setRootUri(java.lang.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.
  - getInitializationOptions
```
@Pure
public java.lang.Object getInitializationOptions()
```
    User provided initialization options.
  - setInitializationOptions
```
public void setInitializationOptions(java.lang.Object initializationOptions)
```
    User provided initialization options.
  - getCapabilities
```
@Pure
public ClientCapabilities getCapabilities()
```
    The capabilities provided by the client (editor or tool)
  - setCapabilities
```
public void setCapabilities(ClientCapabilities capabilities)
```
    The capabilities provided by the client (editor or tool)
  - getClientInfo
```
@Pure
public ClientInfo getClientInfo()
```
    Information about the client
    Since 3.15.0
  - setClientInfo
```
public void setClientInfo(ClientInfo clientInfo)
```
    Information about the client
    Since 3.15.0
  - getLocale
```
@Pure
public java.lang.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
  - setLocale
```
public void setLocale(java.lang.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
  - getTrace
```
@Pure
public java.lang.String getTrace()
```
    The initial trace setting. For values, see TraceValue. If omitted trace is disabled (TraceValue.Off).
  - setTrace
```
public void setTrace(java.lang.String trace)
```
    The initial trace setting. For values, see TraceValue. If omitted trace is disabled (TraceValue.Off).
  - getWorkspaceFolders
```
@Pure
public java.util.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
  - setWorkspaceFolders
```
public void setWorkspaceFolders(java.util.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
  - toString
```
@Pure
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
@Pure
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
@Pure
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class InitializeParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InitializeParams

Method Detail

getWorkDoneToken

setWorkDoneToken

setWorkDoneToken

setWorkDoneToken

getProcessId

setProcessId

getRootPath

setRootPath

getRootUri

setRootUri

getInitializationOptions

setInitializationOptions

getCapabilities

setCapabilities

getClientInfo

setClientInfo

getLocale

setLocale

getTrace

setTrace

getWorkspaceFolders

setWorkspaceFolders

toString

equals

hashCode