Package org.aspectj.asm

Interface IElementHandleProvider

All Known Implementing Classes:

JDTLikeHandleProvider

public interface IElementHandleProvider

Adapter used to uniquely identify program element handles. Can be implemented and overridden in @see{AsmManager} in order to provide IDE-specific mechanisms of identifying elements. For example, AJDT uses workspace-relative paths that are understood by its JavaCore class.

Author:

Mik Kersten

Method Summary

Modifier and Type	Method	Description
String	createHandleIdentifier(File sourceFile, int line, int column, int offset)
String	createHandleIdentifier(IProgramElement ipe)
String	createHandleIdentifier(ISourceLocation location)
String	getFileForHandle(String handle)	NOTE: this is necessary for the current implementation to look up nodes, but we may want to consider removing it.
int	getLineNumberForHandle(String handle)	NOTE: this is necessary for the current implementation to look up nodes, but we may want to consider removing it.
int	getOffSetForHandle(String handle)
void	initialize()	Initializes handle provider state.

Method Details

createHandleIdentifier

String createHandleIdentifier(ISourceLocation location)

Returns:

a String uniquely identifying this element

createHandleIdentifier

String createHandleIdentifier(File sourceFile,
 int line,
 int column,
 int offset)

Returns:

a String uniquely identifying this element

createHandleIdentifier

String createHandleIdentifier(IProgramElement ipe)

Returns:

a String uniquely identifying this element

getFileForHandle

String getFileForHandle(String handle)

NOTE: this is necessary for the current implementation to look up nodes, but we may want to consider removing it.

Returns:

a String corresponding to the

getLineNumberForHandle

int getLineNumberForHandle(String handle)

NOTE: this is necessary for the current implementation to look up nodes, but we may want to consider removing it.

Returns:

the line number corresponding to this handel

getOffSetForHandle

int getOffSetForHandle(String handle)

initialize

void initialize()

Initializes handle provider state. The initializer is invoked when a new ASM is created on a full build.