org.eclipse.xtext.findReferences

Class ReferenceFinder

java.lang.Object

org.eclipse.xtext.findReferences.ReferenceFinder

All Implemented Interfaces:

IReferenceFinder

Direct Known Subclasses:

DefaultReferenceFinder

public class ReferenceFinder
extends java.lang.Object
implements IReferenceFinder

Since:

2.7

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.findReferences.IReferenceFinder

IReferenceFinder.Acceptor, IReferenceFinder.IResourceAccess

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MONITOR_CHUNK_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReferenceFinder()
protected	ReferenceFinder(IResourceServiceProvider.Registry serviceProviderRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doFindReferencesWith(IReferenceFinder referenceFinder, TargetURIs targetURIs, org.eclipse.emf.common.util.URI candidate, IReferenceFinder.IResourceAccess resourceAccess, IResourceDescriptions descriptions, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor)
protected boolean	doProcess(org.eclipse.emf.ecore.EObject sourceCandidate, TargetURIs targetURISet)
protected boolean	doProcess(org.eclipse.emf.ecore.EReference reference, TargetURIs targetURISet)
void	findAllReferences(TargetURIs targetURIs, IReferenceFinder.IResourceAccess resourceAccess, IResourceDescriptions indexData, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor) Finds all references to the given targetURIs.
protected void	findLocalReferencesFromElement(TargetURIs targetURIs, org.eclipse.emf.ecore.EObject sourceCandidate, org.eclipse.emf.ecore.resource.Resource localResource, IReferenceFinder.Acceptor acceptor)
void	findReferences(TargetURIs targetURIs, IResourceDescription resourceDescription, IReferenceFinder.IResourceAccess resourceAccess, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor) Finds the references from the given source resource to the given targetURIs.
void	findReferences(TargetURIs targetURIs, org.eclipse.emf.ecore.resource.Resource resource, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor) Finds the references from the given source resource to the given targetURIs.
void	findReferences(TargetURIs targetURIs, java.util.Set<org.eclipse.emf.common.util.URI> candidates, IReferenceFinder.IResourceAccess resourceAccess, IResourceDescriptions descriptions, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor) Finds all references from a set of source resources to the given targetURIs.
protected void	findReferencesInDescription(TargetURIs targetURIs, IResourceDescription resourceDescription, IReferenceFinder.IResourceAccess resourceAccess, IReferenceFinder.Acceptor acceptor, org.eclipse.core.runtime.IProgressMonitor monitor)
protected IReferenceFinder	getLanguageSpecificReferenceFinder(org.eclipse.emf.common.util.URI candidate)
protected IResourceServiceProvider.Registry	getServiceProviderRegistry()
protected org.eclipse.emf.ecore.EObject	resolveInternalProxy(org.eclipse.emf.ecore.EObject elementOrProxy, org.eclipse.emf.ecore.resource.Resource resource)
protected org.eclipse.emf.ecore.EObject	toValidInstanceOrNull(org.eclipse.emf.ecore.resource.Resource resource, TargetURIs targetURIs, org.eclipse.emf.ecore.EObject value)

Methods inherited from class java.lang.Object

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

Field Detail

MONITOR_CHUNK_SIZE

protected static final int MONITOR_CHUNK_SIZE

See Also:

Constant Field Values

Constructor Detail

ReferenceFinder

@Inject
public ReferenceFinder()

ReferenceFinder

protected ReferenceFinder(IResourceServiceProvider.Registry serviceProviderRegistry)

Method Detail

getServiceProviderRegistry

protected IResourceServiceProvider.Registry getServiceProviderRegistry()

findReferences

public void findReferences(TargetURIs targetURIs,
                  java.util.Set<org.eclipse.emf.common.util.URI> candidates,
                  IReferenceFinder.IResourceAccess resourceAccess,
                  IResourceDescriptions descriptions,
                  IReferenceFinder.Acceptor acceptor,
                  org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IReferenceFinder

Finds all references from a set of source resources to the given targetURIs.

Specified by:

findReferences in interface IReferenceFinder

Parameters:

targetURIs - the URIs of the target elements of the references. Should be normalized.

candidates - the search scope for the resources containing the sources of the references.

resourceAccess - used to find local references. If null, only indexed references are returned.

acceptor - accepts the matches.

monitor - the progress monitor. Can be null.

getLanguageSpecificReferenceFinder

protected IReferenceFinder getLanguageSpecificReferenceFinder(org.eclipse.emf.common.util.URI candidate)

doFindReferencesWith

protected void doFindReferencesWith(IReferenceFinder referenceFinder,
                        TargetURIs targetURIs,
                        org.eclipse.emf.common.util.URI candidate,
                        IReferenceFinder.IResourceAccess resourceAccess,
                        IResourceDescriptions descriptions,
                        IReferenceFinder.Acceptor acceptor,
                        org.eclipse.core.runtime.IProgressMonitor monitor)

findReferences

public void findReferences(TargetURIs targetURIs,
                  org.eclipse.emf.ecore.resource.Resource resource,
                  IReferenceFinder.Acceptor acceptor,
                  org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IReferenceFinder

Finds the references from the given source resource to the given targetURIs.

Specified by:

findReferences in interface IReferenceFinder

Parameters:

targetURIs - the URIs of the target elements of the references. Should be normalized.

resource - the search scope for the resources containing the sources of the references.

acceptor - accepts the matches.

monitor - the progress monitor. Can be null.

findReferences

public void findReferences(TargetURIs targetURIs,
                  IResourceDescription resourceDescription,
                  IReferenceFinder.IResourceAccess resourceAccess,
                  IReferenceFinder.Acceptor acceptor,
                  org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IReferenceFinder

Finds the references from the given source resource to the given targetURIs.

Specified by:

findReferences in interface IReferenceFinder

Parameters:

targetURIs - the URIs of the target elements of the references. Should be normalized.

resourceDescription - the search scope for the resources containing the sources of the references.

resourceAccess - used to find local references. If null, only indexed references are returned.

acceptor - accepts the matches.

monitor - the progress monitor. Can be null.

findReferencesInDescription

protected void findReferencesInDescription(TargetURIs targetURIs,
                               IResourceDescription resourceDescription,
                               IReferenceFinder.IResourceAccess resourceAccess,
                               IReferenceFinder.Acceptor acceptor,
                               org.eclipse.core.runtime.IProgressMonitor monitor)

findAllReferences

public void findAllReferences(TargetURIs targetURIs,
                     IReferenceFinder.IResourceAccess resourceAccess,
                     IResourceDescriptions indexData,
                     IReferenceFinder.Acceptor acceptor,
                     org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IReferenceFinder

Finds all references to the given targetURIs.

Specified by:

findAllReferences in interface IReferenceFinder

Parameters:

targetURIs - the URIs of the target elements of the references. Should be normalized.

resourceAccess - used to find local references. If null, only indexed references are returned.

acceptor - accepts the matches.

monitor - the progress monitor. Can be null.

findLocalReferencesFromElement

protected void findLocalReferencesFromElement(TargetURIs targetURIs,
                                  org.eclipse.emf.ecore.EObject sourceCandidate,
                                  org.eclipse.emf.ecore.resource.Resource localResource,
                                  IReferenceFinder.Acceptor acceptor)

toValidInstanceOrNull

protected org.eclipse.emf.ecore.EObject toValidInstanceOrNull(org.eclipse.emf.ecore.resource.Resource resource,
                                                  TargetURIs targetURIs,
                                                  org.eclipse.emf.ecore.EObject value)

resolveInternalProxy

protected org.eclipse.emf.ecore.EObject resolveInternalProxy(org.eclipse.emf.ecore.EObject elementOrProxy,
                                                 org.eclipse.emf.ecore.resource.Resource resource)

doProcess

protected boolean doProcess(org.eclipse.emf.ecore.EObject sourceCandidate,
                TargetURIs targetURISet)

doProcess

protected boolean doProcess(org.eclipse.emf.ecore.EReference reference,
                TargetURIs targetURISet)