Package oracle.ide.dependency

Provides information about the dependencies between files in an application.

See: Description

Interface Summary

Interface	Description
Declaration	A declaration.
DeclarationProvider	Provides Declaration instances.
IdDeclarationProvider	Provides declarations identified by a unique ID.
ProgressIndicator	Provides progress updates for dependency operations.
Reference	A reference.
ReferenceProvider	Provides Reference instances.
SourceDeclaration	A declaration in a source file.
SourceReference	A reference in a source file.

Class Summary

Class	Description
DependencyManager	Entry point for the Dependency API.
IdDeclaration	A declaration that is identified by a unique ID.
IdReference	A reference to a declaration by ID.
Scope	The scope of a dependency search.
SourceUtils	Utilities for dealing with references and declarations in source files.
URLDeclarationProvider	Provides generic URL declarations.

Package oracle.ide.dependency Description

Provides information about the dependencies between files in an application. Dependency information can be queried through the DependencyManager.

References and Declarations

A depenency consists of a Reference to a Declaration. The Reference.resolve(oracle.ide.Context) method resolves a reference to its corresponding declaration. Both Reference and Declaration have a show() method which displays the reference or declaration to the user. This might open an editor, for example.

Providers

Clients can provide their own refernces and declarations by implementing the ReferenceProvider or DeclarationProvider interfaces. These can be registered using DependencyManager.addReferenceProvider(oracle.ide.dependency.ReferenceProvider) or DependencyManager.addDeclarationProvider(oracle.ide.dependency.DeclarationProvider). The can also be registered through the extension manifest file as follows:

    <hooks>
      <dependency-hook xmlns="http://xmlns.oracle.com/ide/extension">
        <declaration-provider provider-class="my.provider.Class"/>
        <reference-provider provider-class="my.provider.Class"/>
       </dependency-hook>
    </hooks>
 

IdReference and IdDeclaration

IdReference and IdDeclaration are standard implementations of Reference and Declaration that use a unique String ID to identify a declaration. This declaration ID allows a language to make refrences to declarations in another language. All that is requred to make such a reference is the declaration ID, which is provided by the language owning the declaration. The IdReference class will automatically resolve the ID to the corresponding declaration. Clients can provide IdDeclaration instances by implementing IdDeclarationProvider.