Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DocumentSymbolCapabilities

Modifier and Type	Field and Description
private Boolean	hierarchicalDocumentSymbolSupport The client support hierarchical document symbols.
private Boolean	labelSupport The client supports an additional label presented in the UI when registering a document symbol provider.
private SymbolKindCapabilities	symbolKind Specific capabilities for the `SymbolKind`.
private SymbolTagSupportCapabilities	tagSupport The client supports tags on `SymbolInformation`.

Constructor Summary

Access	Constructor and Description
public	DocumentSymbolCapabilities()
public	DocumentSymbolCapabilities(final Boolean dynamicRegistration)
public	DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind)
public	DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind, final Boolean dynamicRegistration)
public	DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind, final Boolean dynamicRegistration, final Boolean hierarchicalDocumentSymbolSupport)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.equals. Indicates whether some other object is "equal to" this one.
public Boolean	getHierarchicalDocumentSymbolSupport() The client support hierarchical document symbols.
public Boolean	getLabelSupport() The client supports an additional label presented in the UI when registering a document symbol provider.
public SymbolKindCapabilities	getSymbolKind() Specific capabilities for the `SymbolKind`.
public SymbolTagSupportCapabilities	getTagSupport() The client supports tags on `SymbolInformation`.
public int	hashCode() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.hashCode. Returns a hash code value for this object.
public void	setHierarchicalDocumentSymbolSupport(final Boolean hierarchicalDocumentSymbolSupport) The client support hierarchical document symbols.
public void	setLabelSupport(final Boolean labelSupport) The client supports an additional label presented in the UI when registering a document symbol provider.
public void	setSymbolKind(final SymbolKindCapabilities symbolKind) Specific capabilities for the `SymbolKind`.
public void	setTagSupport(final SymbolTagSupportCapabilities tagSupport) The client supports tags on `SymbolInformation`.
public String	toString() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.toString. Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.DynamicRegistrationCapabilities:: getDynamicRegistration setDynamicRegistration

Field Detail

hierarchicalDocumentSymbolSupport	back to summary
private Boolean hierarchicalDocumentSymbolSupport The client support hierarchical document symbols. Since 3.10.0

hierarchicalDocumentSymbolSupport

back to summary

private Boolean hierarchicalDocumentSymbolSupport

The client support hierarchical document symbols.

Since 3.10.0

labelSupport	back to summary
private Boolean labelSupport The client supports an additional label presented in the UI when registering a document symbol provider. Since 3.16.0

labelSupport

back to summary

private Boolean labelSupport

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

Since 3.16.0

symbolKind back to summary

symbolKind	back to summary
private SymbolKindCapabilities symbolKind Specific capabilities for the `SymbolKind`. Since 3.4.0

private SymbolKindCapabilities symbolKind

Specific capabilities for the SymbolKind.

Since 3.4.0

tagSupport back to summary

tagSupport	back to summary
private 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

private 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

Constructor Detail

DocumentSymbolCapabilities	back to summary
public DocumentSymbolCapabilities()

DocumentSymbolCapabilities	back to summary
public DocumentSymbolCapabilities(final Boolean dynamicRegistration)

DocumentSymbolCapabilities	back to summary
public DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind)

DocumentSymbolCapabilities	back to summary
public DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind, final Boolean dynamicRegistration)

DocumentSymbolCapabilities	back to summary
public DocumentSymbolCapabilities(final SymbolKindCapabilities symbolKind, final Boolean dynamicRegistration, final Boolean hierarchicalDocumentSymbolSupport)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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 org.eclipse.lsp4j.DynamicRegistrationCapabilities.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

getHierarchicalDocumentSymbolSupport	back to summary
public Boolean getHierarchicalDocumentSymbolSupport() The client support hierarchical document symbols. Since 3.10.0

getHierarchicalDocumentSymbolSupport

back to summary

public Boolean getHierarchicalDocumentSymbolSupport()

The client support hierarchical document symbols.

Since 3.10.0

getLabelSupport	back to summary
public Boolean getLabelSupport() The client supports an additional label presented in the UI when registering a document symbol provider. Since 3.16.0

getLabelSupport

back to summary

public Boolean getLabelSupport()

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

Since 3.16.0

getSymbolKind back to summary

getSymbolKind	back to summary
public SymbolKindCapabilities getSymbolKind() Specific capabilities for the `SymbolKind`. Since 3.4.0

public SymbolKindCapabilities getSymbolKind()

Specific capabilities for the SymbolKind.

Since 3.4.0

getTagSupport back to summary

getTagSupport	back to summary
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

public SymbolTagSupportCapabilities getTagSupport()

Since 3.16.0

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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 org.eclipse.lsp4j.DynamicRegistrationCapabilities.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

setHierarchicalDocumentSymbolSupport	back to summary
public void setHierarchicalDocumentSymbolSupport(final Boolean hierarchicalDocumentSymbolSupport) The client support hierarchical document symbols. Since 3.10.0

setHierarchicalDocumentSymbolSupport

back to summary

public void setHierarchicalDocumentSymbolSupport(final Boolean hierarchicalDocumentSymbolSupport)

The client support hierarchical document symbols.

Since 3.10.0

setLabelSupport	back to summary
public void setLabelSupport(final Boolean labelSupport) The client supports an additional label presented in the UI when registering a document symbol provider. Since 3.16.0

setLabelSupport

back to summary

public void setLabelSupport(final Boolean labelSupport)

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

Since 3.16.0

setSymbolKind back to summary

setSymbolKind	back to summary
public void setSymbolKind(final SymbolKindCapabilities symbolKind) Specific capabilities for the `SymbolKind`. Since 3.4.0

public void setSymbolKind(final SymbolKindCapabilities symbolKind)

Specific capabilities for the SymbolKind.

Since 3.4.0

setTagSupport back to summary

setTagSupport	back to summary
public void setTagSupport(final 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

public void setTagSupport(final SymbolTagSupportCapabilities tagSupport)

Since 3.16.0

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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 org.eclipse.lsp4j.DynamicRegistrationCapabilities.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 DocumentSymbolCapabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail