Package org.eclipse.lsp4j

Class SymbolInformation

java.lang.Object

org.eclipse.lsp4j.SymbolInformation

public class SymbolInformation
extends java.lang.Object

Represents information about programming constructs like variables, classes, interfaces etc. Deprecated Use DocumentSymbol or WorkspaceSymbol instead if supported. This class is deprecated in the LSP specification. It is not annotated with Deprecated annotation because the TextDocumentService.documentSymbol(DocumentSymbolParams) method requires it and causes deprecated warning in the code of all users of that API.

Constructor Summary

Constructors

Constructor	Description
SymbolInformation()	Deprecated.
SymbolInformation(java.lang.String name, SymbolKind kind, Location location)	Deprecated.
SymbolInformation(java.lang.String name, SymbolKind kind, Location location, java.lang.String containerName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getContainerName()	Deprecated.
java.lang.Boolean	getDeprecated()	Deprecated. Use tags instead if supported.
SymbolKind	getKind()	Deprecated.
Location	getLocation()	Deprecated.
java.lang.String	getName()	Deprecated.
java.util.List<SymbolTag>	getTags()	Deprecated.
int	hashCode()
void	setContainerName(java.lang.String containerName)	Deprecated.
void	setDeprecated(java.lang.Boolean deprecated)	Deprecated. Use tags instead if supported.
void	setKind(SymbolKind kind)	Deprecated.
void	setLocation(Location location)	Deprecated.
void	setName(java.lang.String name)	Deprecated.
void	setTags(java.util.List<SymbolTag> tags)	Deprecated.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolInformation

@Deprecated
public SymbolInformation()

Deprecated.

SymbolInformation

@Deprecated
public SymbolInformation(java.lang.String name,
                         SymbolKind kind,
                         Location location)

Deprecated.

SymbolInformation

@Deprecated
public SymbolInformation(java.lang.String name,
                         SymbolKind kind,
                         Location location,
                         java.lang.String containerName)

Deprecated.

Method Detail

getName

@Deprecated
public java.lang.String getName()

Deprecated.

The name of this symbol.

setName

@Deprecated
public void setName(java.lang.String name)

Deprecated.

The name of this symbol.

getKind

@Deprecated
public SymbolKind getKind()

Deprecated.

The kind of this symbol.

setKind

@Deprecated
public void setKind(SymbolKind kind)

Deprecated.

The kind of this symbol.

getTags

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

Deprecated.

Tags for this symbol.

Since 3.16.0

setTags

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

Deprecated.

Tags for this symbol.

Since 3.16.0

getDeprecated

@Deprecated
public java.lang.Boolean getDeprecated()

Deprecated.

Use tags instead if supported.

Indicates if this symbol is deprecated.

Since 3.8.0

setDeprecated

@Deprecated
public void setDeprecated(java.lang.Boolean deprecated)

Deprecated.

Use tags instead if supported.

Indicates if this symbol is deprecated.

Since 3.8.0

getLocation

@Deprecated
public Location getLocation()

Deprecated.

The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more then the actual symbol's name and does normally include things like visibility modifiers.

The range doesn't have to denote a node range in the sense of a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

setLocation

@Deprecated
public void setLocation(Location location)

Deprecated.

The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more then the actual symbol's name and does normally include things like visibility modifiers.

The range doesn't have to denote a node range in the sense of a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

getContainerName

@Deprecated
public java.lang.String getContainerName()

Deprecated.

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

@Deprecated
public void setContainerName(java.lang.String containerName)

Deprecated.

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.

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