Package org.eclipse.lsp4j

Class WorkspaceSymbol

java.lang.Object

org.eclipse.lsp4j.WorkspaceSymbol

public class WorkspaceSymbol
extends java.lang.Object

A special workspace symbol that supports locations without a range

Since 3.17.0

Constructor Summary

Constructors

Constructor	Description
WorkspaceSymbol()
WorkspaceSymbol(java.lang.String name, SymbolKind kind, org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location)
WorkspaceSymbol(java.lang.String name, SymbolKind kind, org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location, java.lang.String containerName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getContainerName()	The name of the symbol containing this symbol.
java.lang.Object	getData()	A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
SymbolKind	getKind()	The kind of this symbol.
org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation>	getLocation()	The location of this symbol.
java.lang.String	getName()	The name of this symbol.
java.util.List<SymbolTag>	getTags()	Tags for this completion item.
int	hashCode()
void	setContainerName(java.lang.String containerName)	The name of the symbol containing this symbol.
void	setData(java.lang.Object data)	A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
void	setKind(SymbolKind kind)	The kind of this symbol.
void	setLocation(org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location)	The location of this symbol.
void	setName(java.lang.String name)	The name of this symbol.
void	setTags(java.util.List<SymbolTag> tags)	Tags for this completion item.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceSymbol

public WorkspaceSymbol()

WorkspaceSymbol

public WorkspaceSymbol(java.lang.String name,
                       SymbolKind kind,
                       org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location)

WorkspaceSymbol

public WorkspaceSymbol(java.lang.String name,
                       SymbolKind kind,
                       org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location,
                       java.lang.String containerName)

Method Detail

getName

public java.lang.String getName()

The name of this symbol.

setName

public void setName(java.lang.String name)

The name of this symbol.

getKind

public SymbolKind getKind()

The kind of this symbol.

setKind

public void setKind(SymbolKind kind)

The kind of this symbol.

getTags

public java.util.List<SymbolTag> getTags()

Tags for this completion item.

setTags

public void setTags(java.util.List<SymbolTag> tags)

Tags for this completion item.

getLocation

public org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> getLocation()

The location of this symbol. Whether a server is allowed to return a location without a range depends on the client capability SymbolCapabilities.resolveSupport.

See also SymbolInformation.location.

setLocation

public void setLocation(org.eclipse.lsp4j.jsonrpc.messages.Either<Location,WorkspaceSymbolLocation> location)

The location of this symbol. Whether a server is allowed to return a location without a range depends on the client capability SymbolCapabilities.resolveSupport.

See also SymbolInformation.location.

getContainerName

public java.lang.String getContainerName()

The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

setContainerName

public void setContainerName(java.lang.String containerName)

The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

getData

public java.lang.Object getData()

A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

setData

public void setData(java.lang.Object data)

A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object