Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.SymbolInformation

Modifier and Type	Field and Description
private String	containerName Deprecated The name of the symbol containing this symbol.
private Boolean	deprecated Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
private SymbolKind	kind Deprecated The kind of this symbol.
private Location	location Deprecated The location of this symbol.
private String	name Deprecated The name of this symbol.
private List<SymbolTag>	tags Deprecated Tags for this symbol.

Access	Constructor and Description
public	SymbolInformation() Deprecated
public	SymbolInformation(final String name, final SymbolKind kind, final Location location) Deprecated
public	SymbolInformation(final String name, final SymbolKind kind, final Location location, final String containerName) Deprecated

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getContainerName() Deprecated The name of the symbol containing this symbol.
public Boolean	getDeprecated() Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
public SymbolKind	getKind() Deprecated The kind of this symbol.
public Location	getLocation() Deprecated The location of this symbol.
public String	getName() Deprecated The name of this symbol.
public List<SymbolTag>	getTags() Deprecated Tags for this symbol.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setContainerName(final String containerName) Deprecated The name of the symbol containing this symbol.
public void	setDeprecated(final Boolean deprecated) Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
public void	setKind(final SymbolKind kind) Deprecated The kind of this symbol.
public void	setLocation(final Location location) Deprecated The location of this symbol.
public void	setName(final String name) Deprecated The name of this symbol.
public void	setTags(final List<SymbolTag> tags) Deprecated Tags for this symbol.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

containerName	back to summary
private 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. Annotations @Deprecated

deprecated back to summary

deprecated	back to summary
private Boolean deprecated Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated. Since 3.8.0 Annotations @Deprecated

private Boolean deprecated

Deprecated

Use tags instead if supported.

Indicates if this symbol is deprecated.

Since 3.8.0

Annotations

@Deprecated

kind	back to summary
private SymbolKind kind Deprecated The kind of this symbol. Annotations @NonNull @Deprecated

location	back to summary
private 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. Annotations @NonNull @Deprecated

location

back to summary

private 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.

Annotations

@NonNull
@Deprecated

name	back to summary
private String name Deprecated The name of this symbol. Annotations @NonNull @Deprecated

tags	back to summary
private List<SymbolTag> tags Deprecated Tags for this symbol. Since 3.16.0 Annotations @Deprecated

Constructor Detail

SymbolInformation	back to summary
public SymbolInformation() Deprecated Annotations @Deprecated

SymbolInformation	back to summary
public SymbolInformation(final String name, final SymbolKind kind, final Location location) Deprecated Annotations @Deprecated

SymbolInformation	back to summary
public SymbolInformation(final String name, final SymbolKind kind, final Location location, final String containerName) Deprecated Annotations @Deprecated

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.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 java.lang.Object.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

getContainerName	back to summary
public 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. Annotations @Deprecated

getContainerName

back to summary

public 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.

Annotations

@Deprecated

getDeprecated back to summary

getDeprecated	back to summary
public Boolean getDeprecated() Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated. Since 3.8.0 Annotations @Deprecated

public Boolean getDeprecated()

Deprecated

Use tags instead if supported.

Indicates if this symbol is deprecated.

Since 3.8.0

Annotations

@Deprecated

getKind	back to summary
public SymbolKind getKind() Deprecated The kind of this symbol. Annotations @NonNull @Deprecated

getKind

back to summary

public SymbolKind getKind()

Deprecated

The kind of this symbol.

Annotations

@NonNull
@Deprecated

getLocation	back to summary
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. Annotations @NonNull @Deprecated

getLocation

back to summary

public Location getLocation()

Deprecated

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.

Annotations

@NonNull
@Deprecated

getName	back to summary
public String getName() Deprecated The name of this symbol. Annotations @NonNull @Deprecated

getName

back to summary

public String getName()

Deprecated

The name of this symbol.

Annotations

@NonNull
@Deprecated

getTags	back to summary
public List<SymbolTag> getTags() Deprecated Tags for this symbol. Since 3.16.0 Annotations @Deprecated

getTags

back to summary

public List<SymbolTag> getTags()

Deprecated

Tags for this symbol.

Since 3.16.0

Annotations

@Deprecated

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.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 java.lang.Object.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

setContainerName	back to summary
public void setContainerName(final 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. Annotations @Deprecated

setContainerName

back to summary

public void setContainerName(final String containerName)

Deprecated

Annotations

@Deprecated

setDeprecated back to summary

setDeprecated	back to summary
public void setDeprecated(final Boolean deprecated) Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated. Since 3.8.0 Annotations @Deprecated

public void setDeprecated(final Boolean deprecated)

Deprecated

Use tags instead if supported.

Indicates if this symbol is deprecated.

Since 3.8.0

Annotations

@Deprecated

setKind	back to summary
public void setKind(final SymbolKind kind) Deprecated The kind of this symbol. Annotations @Deprecated

setKind

back to summary

public void setKind(final SymbolKind kind)

Deprecated

The kind of this symbol.

Annotations

@Deprecated

setLocation	back to summary
public void setLocation(final 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. Annotations @Deprecated

setLocation

back to summary

public void setLocation(final Location location)

Deprecated

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.

Annotations

@Deprecated

setName	back to summary
public void setName(final String name) Deprecated The name of this symbol. Annotations @Deprecated

setName

back to summary

public void setName(final String name)

Deprecated

The name of this symbol.

Annotations

@Deprecated

setTags	back to summary
public void setTags(final List<SymbolTag> tags) Deprecated Tags for this symbol. Since 3.16.0 Annotations @Deprecated

setTags

back to summary

public void setTags(final List<SymbolTag> tags)

Deprecated

Tags for this symbol.

Since 3.16.0

Annotations

@Deprecated

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.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 java.lang.Object.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 SymbolInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail