Package com._1c.g5.v8.dt.bsl.ui.editor.callhierarchy

Class CallHierarchyQuery

java.lang.Object

com._1c.g5.v8.dt.bsl.ui.editor.callhierarchy.CallHierarchyQuery

All Implemented Interfaces:

ICallHierarchyQuery

public class CallHierarchyQuery
extends Object
implements ICallHierarchyQuery

Default implementation of ICallHierarchyQuery for Built-In language

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.xtext.ui.editor.findrefs.EditorResourceAccess	localContextProvider

Constructor Summary

Constructors

Constructor	Description
CallHierarchyQuery()

Method Summary

Modifier and Type	Method	Description
boolean	canRerun()	Returns whether the query can be run more than once.
boolean	canRunInBackground()	Returns whether this query can be run in the background.
ICallHierarchyResult	getCallHierarchyResult()	Returns the call hierarchy result associated with this query.
String	getSignature()	Returns a user readable label for this query.
Iterable<org.eclipse.emf.common.util.URI>	getTargetUris()	Gets target URI for building Call hierarchy tree
void	init(Iterable<org.eclipse.emf.common.util.URI> targetURIs, String signature)	Initializes query.
org.eclipse.core.runtime.IStatus	run(org.eclipse.core.runtime.IProgressMonitor monitor)	This is the method that actually does the work, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

localContextProvider

@Inject
protected org.eclipse.xtext.ui.editor.findrefs.EditorResourceAccess localContextProvider

Constructor Detail

CallHierarchyQuery

public CallHierarchyQuery()

Method Detail

init

public void init(Iterable<org.eclipse.emf.common.util.URI> targetURIs,
                 String signature)

Initializes query. This method should be call before run(IProgressMonitor)

Parameters:

targetURIs - collection of URI for building call hierarchy, can't be null

signature - actual signature for target element for building call hierarchy, can't be null

getTargetUris

public Iterable<org.eclipse.emf.common.util.URI> getTargetUris()

Description copied from interface: ICallHierarchyQuery

Gets target URI for building Call hierarchy tree

Specified by:

getTargetUris in interface ICallHierarchyQuery

Returns:

target URI for building Call hierarchy tree, never null

run

public org.eclipse.core.runtime.IStatus run(org.eclipse.core.runtime.IProgressMonitor monitor)
                                     throws org.eclipse.core.runtime.OperationCanceledException

Description copied from interface: ICallHierarchyQuery

This is the method that actually does the work, i.e. finds the results of the call hierarchy query.

Specified by:

run in interface ICallHierarchyQuery

Parameters:

monitor - the progress monitor to be used, can't be null

Returns:

the status after completion of the call hierarchy job, can't be null

Throws:

org.eclipse.core.runtime.OperationCanceledException - Thrown when the call hierarchy query has been canceled.

getSignature

public String getSignature()

Description copied from interface: ICallHierarchyQuery

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

Specified by:

getSignature in interface ICallHierarchyQuery

Returns:

the user readable label of this query, can't be null

canRerun

public boolean canRerun()

Description copied from interface: ICallHierarchyQuery

Returns whether the query can be run more than once. Some queries may depend on transient information and return false.

Specified by:

canRerun in interface ICallHierarchyQuery

Returns:

whether this query can be run more than once

canRunInBackground

public boolean canRunInBackground()

Description copied from interface: ICallHierarchyQuery

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

Specified by:

canRunInBackground in interface ICallHierarchyQuery

Returns:

whether this query can be run in the background

getCallHierarchyResult

public ICallHierarchyResult getCallHierarchyResult()

Description copied from interface: ICallHierarchyQuery

Returns the call hierarchy result associated with this query. This method can be called before run is called.

Specified by:

getCallHierarchyResult in interface ICallHierarchyQuery

Returns:

this query's call hierarchy result, can't be null