Package org.aspectj.asm

Interface IRelationshipMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

RelationshipMap

public interface IRelationshipMap
extends Serializable

Maps from a program element handles to a list of relationships between that element and other program elements. Each element in the list or relationships is uniquely identified by a kind and a relationship name. For example, the advice affecting a particular shadow (e.g. method call) can be retrieved by calling get on the handle for that method. Symmetrically the method call shadows that an advice affects can be retrieved.

The elements can be stored and looked up as IProgramElement(s), in which cases the element corresponding to the handle is looked up in the containment hierarchy.

put/get methods taking IProgramElement as a parameter are for convenience only. They work identically to calling their counterparts with IProgramElement.getIdentifierHandle()

Author:

Mik Kersten, Andy Clement

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all of the relationships in the map.
List<IRelationship>	get(String sourceHandle)
IRelationship	get(String source, IRelationship.Kind kind, String relationshipName, boolean runtimeTest, boolean createIfMissing)	Return a relationship matching the kind and name for the given element.
List<IRelationship>	get(IProgramElement sourceProgramElement)
IRelationship	get(IProgramElement source, IRelationship.Kind kind, String relationshipName)	Return a relationship matching the kind and name for the given element.
IRelationship	get(IProgramElement source, IRelationship.Kind kind, String relationshipName, boolean runtimeTest, boolean createIfMissing)	Return a relationship matching the kind and name for the given element.
Set<String>	getEntries()
void	put(String handle, IRelationship relationship)
void	put(IProgramElement source, IRelationship relationship)
boolean	remove(String handle, IRelationship relationship)
void	removeAll(String source)

Method Details

get

List<IRelationship> get(IProgramElement sourceProgramElement)

Returns:

list of relationships or null if the source element has no relationships

get

List<IRelationship> get(String sourceHandle)

Returns:

list of relationships or null if the source element has no relationships

get

IRelationship get(IProgramElement source,
 IRelationship.Kind kind,
 String relationshipName,
 boolean runtimeTest,
 boolean createIfMissing)

Return a relationship matching the kind and name for the given element.

Returns:

null if the relationship is not found.

get

IRelationship get(IProgramElement source,
 IRelationship.Kind kind,
 String relationshipName)

Return a relationship matching the kind and name for the given element.

Returns:

null if the relationship is not found.

get

IRelationship get(String source,
 IRelationship.Kind kind,
 String relationshipName,
 boolean runtimeTest,
 boolean createIfMissing)

Return a relationship matching the kind and name for the given element. Creates the relationship if not found.

Returns:

null if the relationship is not found.

put

void put(IProgramElement source,
 IRelationship relationship)

put

void put(String handle,
 IRelationship relationship)

remove

boolean remove(String handle,
 IRelationship relationship)

removeAll

void removeAll(String source)

clear

void clear()

Clear all of the relationships in the map.

getEntries

Set<String> getEntries()