oracle.ide.dependency
Class IdReference

java.lang.Object
  oracle.ide.dependency.IdReference

All Implemented Interfaces:

Reference

Direct Known Subclasses:

IndexReference

public abstract class IdReference
extends java.lang.Object
implements Reference

A reference to a declaration by ID.

See Also:

IdDeclaration, IdDeclarationProvider

Constructor Summary

IdReference()

Method Summary

abstract java.lang.String	getDeclarationId() Get the declaration ID being referenced.
boolean	isReferenceTo(Context context, Declaration declaration) Determine whether this is a reference to a specifc declaration.
Declaration	resolve(Context context) Resolve this reference to the corresponding declaration, if it exists.
abstract boolean	setDeclarationId(java.lang.String id) Change this reference to point to a different declaration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.dependency.Reference

getURL, show

Constructor Detail

IdReference

public IdReference()

Method Detail

getDeclarationId

public abstract java.lang.String getDeclarationId()

Get the declaration ID being referenced.

Returns:

the declaration ID

setDeclarationId

public abstract boolean setDeclarationId(java.lang.String id)

Change this reference to point to a different declaration.

Parameters:

id - the id of the declaration

Returns:

true if the reference is successfully changed, false otherwise

resolve

public Declaration resolve(Context context)
                    throws java.lang.InterruptedException

Description copied from interface: Reference

Resolve this reference to the corresponding declaration, if it exists.

Specified by:

resolve in interface Reference

Parameters:

context - the context

Returns:

the declaration, or null if the declaration is not found

Throws:

java.lang.InterruptedException - if the operation is interrupted

isReferenceTo

public boolean isReferenceTo(Context context,
                             Declaration declaration)

Description copied from interface: Reference

Determine whether this is a reference to a specifc declaration. A simple implementation of this method would be to call Reference.resolve(oracle.ide.Context) and check if the result matches the declaration. But some implementations may be able to optimize this.

Specified by:

isReferenceTo in interface Reference

Parameters:

context - the context

declaration - the declaration

Returns:

true if the reference would resolve to this declaration, false otherwise