Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.WorkspaceSymbol

Modifier and Type	Field and Description
private String	containerName The name of the symbol containing this symbol.
private Object	data A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
private SymbolKind	kind The kind of this symbol.
private Either<Location, WorkspaceSymbolLocation>	location The location of this symbol.
private String	name The name of this symbol.
private List<SymbolTag>	tags Tags for this completion item.

Access	Constructor and Description
public	WorkspaceSymbol()
public	WorkspaceSymbol(final String name, final SymbolKind kind, final Either<Location, WorkspaceSymbolLocation> location)
public	WorkspaceSymbol(final String name, final SymbolKind kind, final Either<Location, WorkspaceSymbolLocation> location, final String containerName)

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() The name of the symbol containing this symbol.
public Object	getData() A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
public SymbolKind	getKind() The kind of this symbol.
public Either<Location, WorkspaceSymbolLocation>	getLocation() The location of this symbol.
public String	getName() The name of this symbol.
public List<SymbolTag>	getTags() Tags for this completion item.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setContainerName(final String containerName) The name of the symbol containing this symbol.
public void	setData(final Object data) A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
public void	setKind(final SymbolKind kind) The kind of this symbol.
public void	setLocation(final Either<Location, WorkspaceSymbolLocation> location) The location of this symbol.
public void	setName(final String name) The name of this symbol.
public void	setTags(final List<SymbolTag> tags) Tags for this completion item.
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

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

data	back to summary
private Object data A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request. Annotations @JsonAdapter:Factory

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

location	back to summary
private 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`. Annotations @NonNull @JsonAdapter:WorkspaceSymbolLocationTypeAdapter

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

tags	back to summary
private List<SymbolTag> tags Tags for this completion item.

WorkspaceSymbol	back to summary
public WorkspaceSymbol()

WorkspaceSymbol	back to summary
public WorkspaceSymbol(final String name, final SymbolKind kind, final Either<Location, WorkspaceSymbolLocation> location)

WorkspaceSymbol	back to summary
public WorkspaceSymbol(final String name, final SymbolKind kind, final Either<Location, WorkspaceSymbolLocation> location, final String containerName)

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() 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	back to summary
public Object getData() A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

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

getLocation back to summary

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

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

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

getTags	back to summary
public List<SymbolTag> getTags() Tags for this completion item.

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

setData	back to summary
public void setData(final Object data) A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

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

setLocation back to summary

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

public void setLocation(final 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.

public Class WorkspaceSymbol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail