oracle.ide.dependency
Class DependencyManager

java.lang.Object
  oracle.ide.dependency.DependencyManager

public abstract class DependencyManager
extends java.lang.Object

Entry point for the Dependency API.

Constructor Summary

DependencyManager()

Method Summary

abstract void	addDeclarationProvider(DeclarationProvider provider) Add a declaration provider.
abstract void	addReferenceProvider(ReferenceProvider provider) Add a reference provider.
abstract java.util.Collection<Reference>	findReferences(Context context, Scope scope, Declaration declaration) Find all references to a declaration.
abstract java.util.Collection<Reference>	findReferences(Context context, Scope scope, Declaration declaration, ProgressIndicator progress) Find all references to a declaration.
abstract Declaration	getDeclaration(Context context) Get the declaration for a context.
abstract java.util.Collection<DeclarationProvider>	getDeclarationProviders() Get the registered declaration providers.
abstract java.util.Collection<Declaration>	getDeclarations(Context context, Node node) Get all declarations for a Node.
static DependencyManager	getDependencyManager() Get the dependency manager instance.
abstract java.util.logging.Logger	getLogger() Get the logger used for dependency-related log messages.
abstract Reference	getReference(Context context) Get the reference for a context.
abstract java.util.Collection<ReferenceProvider>	getReferenceProviders() Get the registered reference providers.
abstract java.util.Collection<Reference>	getReferences(Context context, Node node) Get all references for a Node.
abstract java.util.Collection<Declaration>	getTopLevelDeclarations(Context context, Node node) Get all top-level declarations for a Node.
static void	setDependencyManager(DependencyManager dependencyManager) Set the dependency manager instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyManager

public DependencyManager()

Method Detail

getDependencyManager

public static DependencyManager getDependencyManager()

Get the dependency manager instance.

Returns:

the dependency manager instance

setDependencyManager

public static void setDependencyManager(DependencyManager dependencyManager)

Set the dependency manager instance.

Parameters:

dependencyManager - the dependency manager instance

getLogger

public abstract java.util.logging.Logger getLogger()

Get the logger used for dependency-related log messages.

Returns:

the logger

getDeclaration

public abstract Declaration getDeclaration(Context context)

Get the declaration for a context.

Parameters:

context - the context

Returns:

the declaration

getReference

public abstract Reference getReference(Context context)

Get the reference for a context.

Parameters:

context - the context

Returns:

the reference

getReferences

public abstract java.util.Collection<Reference> getReferences(Context context,
                                                              Node node)
                                                       throws java.lang.InterruptedException

Get all references for a Node.

Parameters:

context - the context

node - the Node

Returns:

the refrences for the Node

Throws:

java.lang.InterruptedException - if the operation is interrupted

java.lang.IllegalStateException - if the method is called on the event thread

getDeclarations

public abstract java.util.Collection<Declaration> getDeclarations(Context context,
                                                                  Node node)
                                                           throws java.lang.InterruptedException

Get all declarations for a Node.

Parameters:

context - the context

node - the Node

Returns:

the declarations for the Node

Throws:

java.lang.InterruptedException - if the operation is interrupted

java.lang.IllegalStateException - if the method is called on the event thread

getTopLevelDeclarations

public abstract java.util.Collection<Declaration> getTopLevelDeclarations(Context context,
                                                                          Node node)
                                                                   throws java.lang.InterruptedException

Get all top-level declarations for a Node.

Some languages have a hierarchy of declarations. Objects further down in the hierarchy can only be accessed through these top-level declarations. For example, methods in a Java class can only be referenced directly through a reference to the Java class. Or columns in a database table might only be referenced through a reference to the table. In those cases, it is possible to search for all references to a Node by searching only for the top-level declarations. This improves performance compared to searching for every declaration in the Node.

Parameters:

context - the context

node - the Node

Returns:

the declarations for the Node

Throws:

java.lang.InterruptedException - if the operation is interrupted

java.lang.IllegalStateException - if the method is called on the event thread

findReferences

public abstract java.util.Collection<Reference> findReferences(Context context,
                                                               Scope scope,
                                                               Declaration declaration)
                                                        throws java.lang.InterruptedException,
                                                               java.lang.IllegalStateException

Find all references to a declaration.

Parameters:

context - the context

scope - the search scope

declaration - the declaration to search for

Returns:

the references to the declaration

Throws:

java.lang.InterruptedException - if the operation is interrupted

java.lang.IllegalStateException - if the method is called on the event thread

findReferences

public abstract java.util.Collection<Reference> findReferences(Context context,
                                                               Scope scope,
                                                               Declaration declaration,
                                                               ProgressIndicator progress)
                                                        throws java.lang.InterruptedException,
                                                               java.lang.IllegalStateException

Find all references to a declaration.

Parameters:

context - the context

scope - the search scope

declaration - the declaration to search for

progress - the progress indicator

Returns:

the references to the declaration

Throws:

java.lang.InterruptedException - if the operation is interrupted

java.lang.IllegalStateException - if the method is called on the event thread

addDeclarationProvider

public abstract void addDeclarationProvider(DeclarationProvider provider)

Add a declaration provider. Note that declaration providers can also be registered through the extension manifest.

Parameters:

provider - the declaration provider

addReferenceProvider

public abstract void addReferenceProvider(ReferenceProvider provider)

Add a reference provider. Note that reference providers can also be registered through the extension manifest.

Parameters:

provider - the reference provider

getDeclarationProviders

public abstract java.util.Collection<DeclarationProvider> getDeclarationProviders()

Get the registered declaration providers.

Returns:

the declaration providers

getReferenceProviders

public abstract java.util.Collection<ReferenceProvider> getReferenceProviders()

Get the registered reference providers.

Returns:

the reference providers