Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class TypeHierarchyItem

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, java.util.List, org.eclipse.lsp4j.jsonrpc.json.adapters.JsonElementTypeAdapter, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

Representation of an item that carries type information.

Since 3.17.0

Field Summary

Modifier and TypeField and Description
private Object
data

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests.

private String
detail

More detail for this item, e.g. the signature of a function.

private SymbolKind
kind

The kind of this item.

private String
name

The name of this item.

private Range
range

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

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

private String
uri

The resource identifier of this item.

Constructor Summary

AccessConstructor and Description
public
TypeHierarchyItem(final String name, final SymbolKind kind, final String uri, final Range range, final Range selectionRange)

public
TypeHierarchyItem(final String name, final SymbolKind kind, final String uri, final Range range, final Range selectionRange, final String detail)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Object
getData()

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests.

public String
getDetail()

More detail for this item, e.g. the signature of a function.

public SymbolKind
getKind()

The kind of this item.

public String
getName()

The name of this item.

public Range
getRange()

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

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

public String
getUri()

The resource identifier of this item.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setData(final Object data)

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests.

public void
setDetail(final String detail)

More detail for this item, e.g. the signature of a function.

public void
setKind(final SymbolKind kind)

The kind of this item.

public void
setName(final String name)

The name of this item.

public void
setRange(final Range range)

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

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

public void
setUri(final String uri)

The resource identifier of this item.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

databack to summary
private Object data

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.

Annotations
@JsonAdapter:Factory
detailback to summary
private String detail

More detail for this item, e.g. the signature of a function.

kindback to summary
private SymbolKind kind

The kind of this item.

Annotations
@NonNull
nameback to summary
private String name

The name of this item.

Annotations
@NonNull
rangeback to summary
private Range range

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

Annotations
@NonNull
selectionRangeback 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
tagsback to summary
private List<SymbolTag> tags

Tags for this item.

uriback to summary
private String uri

The resource identifier of this item.

Annotations
@NonNull

Constructor Detail

TypeHierarchyItemback to summary
public TypeHierarchyItem(final String name, final SymbolKind kind, final String uri, final Range range, final Range selectionRange)
TypeHierarchyItemback to summary
public TypeHierarchyItem(final String name, final SymbolKind kind, final String uri, final Range range, final Range selectionRange, final String detail)

Method Detail

equalsback 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
getDataback to summary
public Object getData()

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.

getDetailback to summary
public String getDetail()

More detail for this item, e.g. the signature of a function.

getKindback to summary
public SymbolKind getKind()

The kind of this item.

Annotations
@NonNull
getNameback to summary
public String getName()

The name of this item.

Annotations
@NonNull
getRangeback to summary
public Range getRange()

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

Annotations
@NonNull
getSelectionRangeback 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
getTagsback to summary
public List<SymbolTag> getTags()

Tags for this item.

getUriback to summary
public String getUri()

The resource identifier of this item.

Annotations
@NonNull
hashCodeback 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
setDataback to summary
public void setData(final Object data)

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.

setDetailback to summary
public void setDetail(final String detail)

More detail for this item, e.g. the signature of a function.

setKindback to summary
public void setKind(final SymbolKind kind)

The kind of this item.

setNameback to summary
public void setName(final String name)

The name of this item.

setRangeback to summary
public void setRange(final Range range)

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

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

setTagsback to summary
public void setTags(final List<SymbolTag> tags)

Tags for this item.

setUriback to summary
public void setUri(final String uri)

The resource identifier of this item.

toStringback 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