Package org.aspectj.asm

Interface IHierarchy

All Superinterfaces:

Serializable

All Known Implementing Classes:

AspectJElementHierarchy

public interface IHierarchy
extends Serializable

Author:

Mik Kersten, Andy Clement

Field Summary

Fields

Modifier and Type	Field	Description
static final IProgramElement	NO_STRUCTURE

Method Summary

Modifier and Type	Method	Description
void	addToFileMap(String canonicalFilePath, IProgramElement compilationUnitProgramElement)
IProgramElement	findCloserMatchForLineNumber(IProgramElement node, int lineno)	For a specified node, check if any of the children more accurately represent the specified line.
IProgramElement	findElementForHandle(String handle)
IProgramElement	findElementForHandleOrCreate(String handle, boolean create)
IProgramElement	findElementForLabel(IProgramElement parent, IProgramElement.Kind kind, String label)	Returns the first match
IProgramElement	findElementForOffSet(String sourceFilePath, int lineNumber, int offSet)
IProgramElement	findElementForSignature(IProgramElement parent, IProgramElement.Kind kind, String signature)	Returns the first match
IProgramElement	findElementForSourceFile(String sourceFile)
IProgramElement	findElementForSourceLine(String sourceFilePath, int lineNumber)	Never returns null
IProgramElement	findElementForSourceLine(ISourceLocation location)	TODO: discriminate columns
IProgramElement	findElementForType(String packageName, String typeName)
IProgramElement	findInFileMap(String key)
IProgramElement	findNodeForSourceFile(IProgramElement node, String sourcefilePath)	Discover the node representing a particular source file.
void	flushHandleMap()
void	flushTypeMap()
String	getConfigFile()
IProgramElement	getElement(String handle)
Set<Map.Entry<String,IProgramElement>>	getFileMapEntrySet()
IProgramElement	getRoot()
boolean	isValid()
boolean	removeFromFileMap(String canonicalFilePath)
void	setConfigFile(String configFile)
default void	setFileMap(HashMap<String,IProgramElement> fileMap)
void	setFileMap(Map<String,IProgramElement> fileMap)
void	setRoot(IProgramElement root)
void	updateHandleMap(Set<String> deletedFiles)

Field Details

NO_STRUCTURE

static final IProgramElement NO_STRUCTURE

Method Details

getElement

IProgramElement getElement(String handle)

getRoot

IProgramElement getRoot()

setRoot

void setRoot(IProgramElement root)

addToFileMap

void addToFileMap(String canonicalFilePath,
 IProgramElement compilationUnitProgramElement)

removeFromFileMap

boolean removeFromFileMap(String canonicalFilePath)

setFileMap

void setFileMap(Map<String,IProgramElement> fileMap)

setFileMap

default void setFileMap(HashMap<String,IProgramElement> fileMap)

findInFileMap

IProgramElement findInFileMap(String key)

getFileMapEntrySet

Set<Map.Entry<String,IProgramElement>> getFileMapEntrySet()

isValid

boolean isValid()

findElementForHandle

IProgramElement findElementForHandle(String handle)

findElementForHandleOrCreate

IProgramElement findElementForHandleOrCreate(String handle,
 boolean create)

findElementForSignature

IProgramElement findElementForSignature(IProgramElement parent,
 IProgramElement.Kind kind,
 String signature)

Returns the first match

Parameters:

parent -

kind - not null

Returns:

null if not found

findElementForLabel

IProgramElement findElementForLabel(IProgramElement parent,
 IProgramElement.Kind kind,
 String label)

Returns the first match

Parameters:

parent -

kind - not null

Returns:

null if not found

findElementForType

IProgramElement findElementForType(String packageName,
 String typeName)

Parameters:

packageName - if null default package is searched

typeName - can't be null

findElementForSourceFile

IProgramElement findElementForSourceFile(String sourceFile)

Parameters:

sourceFile - modified to '/' delimited path for consistency

Returns:

a new structure node for the file if it was not found in the model

findElementForSourceLine

IProgramElement findElementForSourceLine(ISourceLocation location)

TODO: discriminate columns

findElementForSourceLine

IProgramElement findElementForSourceLine(String sourceFilePath,
 int lineNumber)

Never returns null

Parameters:

sourceFilePath - canonicalized path for consistency

lineNumber - if 0 or 1 the corresponding file node will be returned

Returns:

a new structure node for the file if it was not found in the model

findElementForOffSet

IProgramElement findElementForOffSet(String sourceFilePath,
 int lineNumber,
 int offSet)

getConfigFile

String getConfigFile()

setConfigFile

void setConfigFile(String configFile)

flushTypeMap

void flushTypeMap()

flushHandleMap

void flushHandleMap()

updateHandleMap

void updateHandleMap(Set<String> deletedFiles)

findCloserMatchForLineNumber

IProgramElement findCloserMatchForLineNumber(IProgramElement node,
 int lineno)

For a specified node, check if any of the children more accurately represent the specified line.

Parameters:

node - where to start looking

lineno - the line number

Returns:

any closer match below 'node' or null if nothing is a more accurate match

findNodeForSourceFile

IProgramElement findNodeForSourceFile(IProgramElement node,
 String sourcefilePath)

Discover the node representing a particular source file.

Parameters:

node - where in the model to start looking (usually the root on the initial call)

sourcefilePath - the source file being searched for

Returns:

the node representing that source file or null if it cannot be found