Package org.eclipse.lsp4j

Class DocumentSymbolCapabilities

java.lang.Object

org.eclipse.lsp4j.DynamicRegistrationCapabilities

org.eclipse.lsp4j.DocumentSymbolCapabilities

public class DocumentSymbolCapabilities
extends DynamicRegistrationCapabilities

Capabilities specific to the `textDocument/documentSymbol`

Constructor Summary

Constructors

Constructor	Description
DocumentSymbolCapabilities()
DocumentSymbolCapabilities(java.lang.Boolean dynamicRegistration)
DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind)
DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind, java.lang.Boolean dynamicRegistration)
DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind, java.lang.Boolean dynamicRegistration, java.lang.Boolean hierarchicalDocumentSymbolSupport)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getHierarchicalDocumentSymbolSupport()	The client support hierarchical document symbols.
java.lang.Boolean	getLabelSupport()	The client supports an additional label presented in the UI when registering a document symbol provider.
SymbolKindCapabilities	getSymbolKind()	Specific capabilities for the SymbolKind.
SymbolTagSupportCapabilities	getTagSupport()	The client supports tags on SymbolInformation.
int	hashCode()
void	setHierarchicalDocumentSymbolSupport(java.lang.Boolean hierarchicalDocumentSymbolSupport)	The client support hierarchical document symbols.
void	setLabelSupport(java.lang.Boolean labelSupport)	The client supports an additional label presented in the UI when registering a document symbol provider.
void	setSymbolKind(SymbolKindCapabilities symbolKind)	Specific capabilities for the SymbolKind.
void	setTagSupport(SymbolTagSupportCapabilities tagSupport)	The client supports tags on SymbolInformation.
java.lang.String	toString()

Methods inherited from class org.eclipse.lsp4j.DynamicRegistrationCapabilities

getDynamicRegistration, setDynamicRegistration

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentSymbolCapabilities

public DocumentSymbolCapabilities()

DocumentSymbolCapabilities

public DocumentSymbolCapabilities(java.lang.Boolean dynamicRegistration)

DocumentSymbolCapabilities

public DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind)

DocumentSymbolCapabilities

public DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind,
                                  java.lang.Boolean dynamicRegistration)

DocumentSymbolCapabilities

public DocumentSymbolCapabilities(SymbolKindCapabilities symbolKind,
                                  java.lang.Boolean dynamicRegistration,
                                  java.lang.Boolean hierarchicalDocumentSymbolSupport)

Method Detail

getSymbolKind

public SymbolKindCapabilities getSymbolKind()

Specific capabilities for the SymbolKind.

Since 3.4.0

setSymbolKind

public void setSymbolKind(SymbolKindCapabilities symbolKind)

Specific capabilities for the SymbolKind.

Since 3.4.0

getHierarchicalDocumentSymbolSupport

public java.lang.Boolean getHierarchicalDocumentSymbolSupport()

The client support hierarchical document symbols.

Since 3.10.0

setHierarchicalDocumentSymbolSupport

public void setHierarchicalDocumentSymbolSupport(java.lang.Boolean hierarchicalDocumentSymbolSupport)

The client support hierarchical document symbols.

Since 3.10.0

getTagSupport

public SymbolTagSupportCapabilities getTagSupport()

The client supports tags on SymbolInformation. Tags are supported on DocumentSymbol if hierarchicalDocumentSymbolSupport is set to true. Clients supporting tags have to handle unknown tags gracefully.

Since 3.16.0

setTagSupport

public void setTagSupport(SymbolTagSupportCapabilities tagSupport)

The client supports tags on SymbolInformation. Tags are supported on DocumentSymbol if hierarchicalDocumentSymbolSupport is set to true. Clients supporting tags have to handle unknown tags gracefully.

Since 3.16.0

getLabelSupport

public java.lang.Boolean getLabelSupport()

The client supports an additional label presented in the UI when registering a document symbol provider.

Since 3.16.0

setLabelSupport

public void setLabelSupport(java.lang.Boolean labelSupport)

The client supports an additional label presented in the UI when registering a document symbol provider.

Since 3.16.0

toString

public java.lang.String toString()

Overrides:

toString in class DynamicRegistrationCapabilities

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DynamicRegistrationCapabilities

hashCode

public int hashCode()

Overrides:

hashCode in class DynamicRegistrationCapabilities