Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DocumentSymbol

Modifier and Type	Field and Description
private List<DocumentSymbol>	children Children of this symbol, e.g. properties of a class.
private Boolean	deprecated Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
private String	detail More detail for this symbol, e.g the signature of a function.
private SymbolKind	kind The kind of this symbol.
private String	name The name of this symbol.
private Range	range The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
private Range	selectionRange The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
private List<SymbolTag>	tags Tags for this document symbol.

Constructor Summary

Access	Constructor and Description
public	DocumentSymbol()
public	DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange)
public	DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange, final String detail)
public	DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange, final String detail, final List<DocumentSymbol> children)

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 List<DocumentSymbol>	getChildren() Children of this symbol, e.g. properties of a class.
public Boolean	getDeprecated() Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
public String	getDetail() More detail for this symbol, e.g the signature of a function.
public SymbolKind	getKind() The kind of this symbol.
public String	getName() The name of this symbol.
public Range	getRange() The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
public Range	getSelectionRange() The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
public List<SymbolTag>	getTags() Tags for this document symbol.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setChildren(final List<DocumentSymbol> children) Children of this symbol, e.g. properties of a class.
public void	setDeprecated(final Boolean deprecated) Deprecated Use `tags` instead if supported. Indicates if this symbol is deprecated.
public void	setDetail(final String detail) More detail for this symbol, e.g the signature of a function.
public void	setKind(final SymbolKind kind) The kind of this symbol.
public void	setName(final String name) The name of this symbol.
public void	setRange(final Range range) The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
public void	setSelectionRange(final Range selectionRange) The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
public void	setTags(final List<SymbolTag> tags) Tags for this document 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

children	back to summary
private List<DocumentSymbol> children Children of this symbol, e.g. properties of a class.

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

detail	back to summary
private String detail More detail for this symbol, e.g the signature of a function. If not provided the name is used.

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

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

range	back to summary
private Range range The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the client's cursor is inside the symbol to reveal the symbol in the UI. Annotations @NonNull

selectionRange	back to summary
private Range selectionRange The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the `range`. Annotations @NonNull

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

Constructor Detail

DocumentSymbol	back to summary
public DocumentSymbol()

DocumentSymbol	back to summary
public DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange)

DocumentSymbol	back to summary
public DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange, final String detail)

DocumentSymbol	back to summary
public DocumentSymbol(final String name, final SymbolKind kind, final Range range, final Range selectionRange, final String detail, final List<DocumentSymbol> children)

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

getChildren	back to summary
public List<DocumentSymbol> getChildren() Children of this symbol, e.g. properties of a class.

getDeprecated back to summary

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

public Boolean getDeprecated()

Deprecated

Use tags instead if supported.

Indicates if this symbol is deprecated.

Annotations

@Deprecated

getDetail	back to summary
public String getDetail() More detail for this symbol, e.g the signature of a function. If not provided the name is used.

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

getKind

back to summary

public SymbolKind getKind()

The kind of this symbol.

Annotations

@NonNull

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

getName

back to summary

public String getName()

The name of this symbol.

Annotations

@NonNull

getRange	back to summary
public Range getRange() The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the client's cursor is inside the symbol to reveal the symbol in the UI. Annotations @NonNull

getRange

back to summary

public Range getRange()

The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the client's cursor is inside the symbol to reveal the symbol in the UI.

Annotations

@NonNull

getSelectionRange back to summary

getSelectionRange	back to summary
public Range getSelectionRange() The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the `range`. Annotations @NonNull

public Range getSelectionRange()

The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the range.

Annotations

@NonNull

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

getTags

back to summary

public List<SymbolTag> getTags()

Tags for this document symbol.

Since 3.16.0

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

setChildren	back to summary
public void setChildren(final List<DocumentSymbol> children) Children of this symbol, e.g. properties of a class.

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. Annotations @Deprecated

public void setDeprecated(final Boolean deprecated)

Deprecated

Use tags instead if supported.

Indicates if this symbol is deprecated.

Annotations

@Deprecated

setDetail	back to summary
public void setDetail(final String detail) More detail for this symbol, e.g the signature of a function. If not provided the name is used.

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

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

setRange	back to summary
public void setRange(final Range range) The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the client's cursor is inside the symbol to reveal the symbol in the UI.

setSelectionRange	back to summary
public void setSelectionRange(final Range selectionRange) The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the `range`.

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

setTags

back to summary

public void setTags(final List<SymbolTag> tags)

Tags for this document symbol.

Since 3.16.0

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 DocumentSymbol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail