oracle.ide.dependency

Class URLDeclarationProvider

java.lang.Object

oracle.ide.dependency.URLDeclarationProvider

All Implemented Interfaces:

DeclarationProvider, IdDeclarationProvider

public class URLDeclarationProvider
extends java.lang.Object
implements IdDeclarationProvider

Provides generic URL declarations. Clients should generally refrence more specific objects when possible. This provider is for cases where the client does not know anything more about a reference than the URL it points to.

Constructor Summary

Constructors

Constructor and Description
URLDeclarationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGetDeclaration(Context context) Determine whether there could be a declaration in the context.
boolean	canGetDeclaration(Context context, java.lang.String id) Determine whether this provider can supply the declaration for an ID.
boolean	canGetDeclarations(Context context, Node node) Determine whether this provider can get declarations for a Node.
Declaration	getDeclaration(Context context) Get the declaration for the given context.
IdDeclaration	getDeclaration(Context context, java.lang.String id) Get the declaration corresponding to an ID.
static java.lang.String	getDeclarationId(java.net.URL url) Get the declaration ID for a URL.
java.util.Collection<? extends Declaration>	getDeclarations(Context context, Node node) Get all declarations for a Node.
java.util.Collection<? extends Declaration>	getTopLevelDeclarations(Context context, Node node) Get all top-level declarations for a Node.
static java.net.URL	getURL(java.lang.String id) Get the URL for a declaration ID.
static boolean	isURLDeclaration(java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

URLDeclarationProvider

public URLDeclarationProvider()

Method Detail

getDeclarationId

public static java.lang.String getDeclarationId(java.net.URL url)

Get the declaration ID for a URL.

Parameters:

url - the URL

Returns:

the declaration ID

getURL

public static java.net.URL getURL(java.lang.String id)

Get the URL for a declaration ID.

Parameters:

id - the declaration ID

Returns:

the URL, or null if the ID is not a URL declaration ID

isURLDeclaration

public static boolean isURLDeclaration(java.lang.String id)

canGetDeclaration

public boolean canGetDeclaration(Context context,
                        java.lang.String id)

Description copied from interface: IdDeclarationProvider

Determine whether this provider can supply the declaration for an ID. Implementations should return true if they are responsible for this ID, regardless of whether the declaration actually exists.

Specified by:

canGetDeclaration in interface IdDeclarationProvider

Parameters:

context - the context

id - the declaration ID

Returns:

true if the provider can find the declaration

getDeclaration

public IdDeclaration getDeclaration(Context context,
                           java.lang.String id)
                             throws java.lang.InterruptedException

Description copied from interface: IdDeclarationProvider

Get the declaration corresponding to an ID.

Specified by:

getDeclaration in interface IdDeclarationProvider

Parameters:

context - the context

id - the declaration ID

Returns:

the declaration, or null if the declaration is not found

Throws:

java.lang.InterruptedException - if the operation is interrupted

canGetDeclaration

public boolean canGetDeclaration(Context context)

Description copied from interface: DeclarationProvider

Determine whether there could be a declaration in the context. The implementation of this method should be very fast, as it is called from the event thread to enable or disable dependency-related actions.

Specified by:

canGetDeclaration in interface DeclarationProvider

Parameters:

context - the context

Returns:

true if this provider may have a declaration in the context, false otherwise

getDeclaration

public Declaration getDeclaration(Context context)

Description copied from interface: DeclarationProvider

Get the declaration for the given context. This will only be called if DeclarationProvider.canGetDeclaration(oracle.ide.Context) returned true for this context.

Specified by:

getDeclaration in interface DeclarationProvider

Parameters:

context - the context

Returns:

the declaration

canGetDeclarations

public boolean canGetDeclarations(Context context,
                         Node node)

Description copied from interface: DeclarationProvider

Determine whether this provider can get declarations for a Node.

Specified by:

canGetDeclarations in interface DeclarationProvider

Parameters:

context - the context

node - the Node

Returns:

true if the provider can get declarations for this Node, false otherwise

getDeclarations

public java.util.Collection<? extends Declaration> getDeclarations(Context context,
                                                          Node node)

Description copied from interface: DeclarationProvider

Get all declarations for a Node.

Specified by:

getDeclarations in interface DeclarationProvider

Parameters:

context - the context

node - the Node

Returns:

the declarations

getTopLevelDeclarations

public java.util.Collection<? extends Declaration> getTopLevelDeclarations(Context context,
                                                                  Node node)

Description copied from interface: DeclarationProvider

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. Implementations that do not have such a declaration hierarchy can simply call DeclarationProvider.getDeclarations(Context,Node).

Specified by:

getTopLevelDeclarations in interface DeclarationProvider

Parameters:

context - the context

node - the Node

Returns:

the top-level declarations