Interface ICallHierarchyQuery

  • All Known Implementing Classes:

    public interface ICallHierarchyQuery
    Represents a particular call hierarchy query. When its run method is called, the query places any results it finds in the ICallHierarchyResult that can be accessed via getCallHierarchyResult(). Note that getCallHierarchyResult() may be called at any time, even before the run() method has been called. An empty call hierarchy result should be returned in that case.
    • Method Detail

      • getTargetUris

        Iterable<org.eclipse.emf.common.util.URI> getTargetUris()
        Gets target URI for building Call hierarchy tree
        target URI for building Call hierarchy tree, never null
      • run

        org.eclipse.core.runtime.IStatus run​(org.eclipse.core.runtime.IProgressMonitor monitor)
                                      throws org.eclipse.core.runtime.OperationCanceledException
        This is the method that actually does the work, i.e. finds the results of the call hierarchy query.
        monitor - the progress monitor to be used, can't be null
        the status after completion of the call hierarchy job, can't be null
        org.eclipse.core.runtime.OperationCanceledException - Thrown when the call hierarchy query has been canceled.
      • getSignature

        String getSignature()
        Returns a user readable label for this query. This will be used, for example to set the Job name if this query is executed in the background. Note that progress notification (for example, the number of matches found) should be done via the progress monitor passed into the run(IProgressMonitor) method
        the user readable label of this query, can't be null
      • canRerun

        boolean canRerun()
        Returns whether the query can be run more than once. Some queries may depend on transient information and return false.
        whether this query can be run more than once
      • canRunInBackground

        boolean canRunInBackground()
        Returns whether this query can be run in the background. Note that queries must do proper locking when they are run in the background (e.g. get the appropriate workspace locks).
        whether this query can be run in the background
      • getCallHierarchyResult

        ICallHierarchyResult getCallHierarchyResult()
        Returns the call hierarchy result associated with this query. This method can be called before run is called.
        this query's call hierarchy result, can't be null