org.netbeans.spi.lsp

Interface CallHierarchyProvider

public interface CallHierarchyProvider

Provides call hierarchy for the given location in a document. May provide list of calls originating from an element (i.e. method, field initializer), or callers to the element at the passed document's offset.

First CallHierarchyProvider.findCallOrigin(javax.swing.text.Document, int) should be called, producing a CallHierarchyEntry that describes the element at the given position. In subsequent calls, inbound or outbound calls may be inspected for the passed Entry using CallHierarchyProvider.findIncomingCalls(org.netbeans.api.lsp.CallHierarchyEntry) or #findOugoingCalls.

Note that the returned CompletableFutures may become completed cancelled if the implementation (for example) displays user-facing UI like progress, which allows the user to interrupt the operation. If the reported exception is a CompletionException, its cause should be also checked.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
CompletableFuture<List<CallHierarchyEntry>>	findCallOrigin(Document doc, int offset) Returns a CallHierarchyEntry that corresponds to the given document's location.
CompletableFuture<List<CallHierarchyEntry.Call>>	findIncomingCalls(CallHierarchyEntry callTarget) Returns a list of locations that call into the passed call target.
CompletableFuture<List<CallHierarchyEntry.Call>>	findOutgoingCalls(CallHierarchyEntry callSource) Returns a list of locations that are called from the passed source.

Method Detail

findCallOrigin

@CheckForNull
CompletableFuture<List<CallHierarchyEntry>> findCallOrigin(@NonNull
                                                                         Document doc,
                                                                         int offset)

Returns a CallHierarchyEntry that corresponds to the given document's location. If the location does not represent a valid starting point, the returned Future will complete with null result. Any errors, i.e. parsing or I/O will be reported through the returned Future.

Parameters:

doc - the document

offset - location in the document

Returns:

location entry, or null

findIncomingCalls

@CheckForNull
CompletableFuture<List<CallHierarchyEntry.Call>> findIncomingCalls(@NonNull
                                                                                 CallHierarchyEntry callTarget)

Returns a list of locations that call into the passed call target. The method may return null, if the call target location is not supported or is invalid. The Call.getRanges() describes ranges int he caller StructureElement where the target is invoked.

Parameters:

callTarget - the call target location

Returns:

list of callers, or null

findOutgoingCalls

@CheckForNull
CompletableFuture<List<CallHierarchyEntry.Call>> findOutgoingCalls(@NonNull
                                                                                 CallHierarchyEntry callSource)

Returns a list of locations that are called from the passed source. The method may return null, if the call target location is not supported or is invalid. The Call.getRanges() describe ranges in the call source, where the specific StructureElement target is called from.

Parameters:

callSource - the location to inspect

Returns:

list of callees, or null