org.netbeans.api.lsp

Class CallHierarchyEntry

java.lang.Object

org.netbeans.api.lsp.CallHierarchyEntry

public final class CallHierarchyEntry
extends Object

Represents an entry in a call hierarchy chain. The entry identifies an element in a source which is the origin or target of an invocation/call.

Since:

1.9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallHierarchyEntry.Call This structure is used for two purposes.

Constructor Summary

Constructors

Constructor and Description
CallHierarchyEntry(StructureElement element, String customData) Constructs a new entry object.

Method Summary

Modifier and Type	Method and Description
String	getCustomData() Returns an opaque, mime type specific data which shall be interpreted by the CallHierarchyProvider in subsequent calls.
StructureElement	getElement() Returns description of the call hierarchy element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CallHierarchyEntry

public CallHierarchyEntry(StructureElement element,
                          String customData)

Constructs a new entry object.

Parameters:

element - represents call target or call origin, depending on usage

customData - implementation-specific data

Method Detail

getElement

@NonNull
public StructureElement getElement()

Returns description of the call hierarchy element. See StructureElement for structure details,

Returns:

description of the structural languagein call hierarchy

getCustomData

@CheckForNull
public String getCustomData()

Returns an opaque, mime type specific data which shall be interpreted by the CallHierarchyProvider in subsequent calls. For example, method signature can be put here.

Returns:

provider-specific data