public abstract class IndexReferenceProvider extends java.lang.Object implements ReferenceProvider
Constructor and Description |
---|
IndexReferenceProvider() |
Modifier and Type | Method and Description |
---|---|
boolean |
canFindReferences(Context context,
Scope scope,
Declaration declaration)
Determine whether this provider can find references to a declaration.
|
boolean |
canGetReference(Context context)
Determine whether there could be a reference in the context.
|
boolean |
canGetReferences(Context context,
Node node)
Determine whether this provider can get references for a Node.
|
java.util.Collection<? extends Reference> |
findReferences(Context context,
Scope scope,
Declaration declaration,
ProgressIndicator progress)
Find all references to the given declaration that this provider knows
about.
|
protected ContentSet |
getContentSet(Context context,
Project project,
Declaration declaration)
Get the content set that should be searched for references to a
declaration.
|
Reference |
getReference(Context context)
Get the reference for the given context, or null if there is no
reference in this context.
|
protected abstract java.util.Collection<QueryCriteria> |
getReferenceCriteria(Context context,
Declaration declaration)
Get the index query criteria to use to search for references to a
declaration.
|
java.util.Collection<? extends Reference> |
getReferences(Context context,
Node node)
Get all references for a Node.
|
protected boolean |
verify(Context context,
IndexReference reference,
Declaration declaration)
Verify that a reference points to a declaration.
|
protected abstract java.util.Collection<QueryCriteria> getReferenceCriteria(Context context, Declaration declaration)
context
- the contextdeclaration
- the declarationprotected ContentSet getContentSet(Context context, Project project, Declaration declaration)
context
- the contextproject
- the project being searcheddeclaration
- the declarationnull
to search the entire projectpublic boolean canGetReference(Context context)
ReferenceProvider
canGetReference
in interface ReferenceProvider
context
- the contextpublic Reference getReference(Context context)
ReferenceProvider
ReferenceProvider.canGetReference(oracle.ide.Context)
returned true for this context.getReference
in interface ReferenceProvider
context
- the contextpublic boolean canGetReferences(Context context, Node node)
ReferenceProvider
canGetReferences
in interface ReferenceProvider
context
- the contextnode
- the Nodepublic java.util.Collection<? extends Reference> getReferences(Context context, Node node) throws java.lang.InterruptedException
ReferenceProvider
getReferences
in interface ReferenceProvider
context
- the contextnode
- the Nodejava.lang.InterruptedException
- if the operation is interruptedpublic boolean canFindReferences(Context context, Scope scope, Declaration declaration)
ReferenceProvider
canFindReferences
in interface ReferenceProvider
context
- the contextdeclaration
- the declarationpublic java.util.Collection<? extends Reference> findReferences(Context context, Scope scope, Declaration declaration, ProgressIndicator progress) throws java.lang.InterruptedException
ReferenceProvider
ReferenceProvider.canFindReferences(Context, Scope, Declaration)
returns true for this context and declaration.findReferences
in interface ReferenceProvider
context
- the contextdeclaration
- the declaration to search forprogress
- the progress indicatorjava.lang.InterruptedException
- if the operation is interruptedprotected boolean verify(Context context, IndexReference reference, Declaration declaration) throws java.lang.InterruptedException
context
- the contextreference
- the referencedeclaration
- the declarationjava.lang.InterruptedException
- if the operation is interrupted