org.walkmod.javalang.ast

Interface SymbolDefinition

All Superinterfaces:

ScopeAware

All Known Implementing Classes:

AnnotationDeclaration, AnnotationMemberDeclaration, BaseParameter, ClassOrInterfaceDeclaration, ClassOrInterfaceType, ConstructorDeclaration, EmptyTypeDeclaration, EnumConstantDeclaration, EnumDeclaration, FieldDeclaration, ImportDeclaration, MethodDeclaration, MultiTypeParameter, ObjectCreationExpr, Parameter, TypeDeclaration, TypeDeclarationStmt, TypeParameter, VariableDeclarator

public interface SymbolDefinition
extends ScopeAware

Represents a node that is a symbol or a set of symbols. A symbol is an identifiable node that can be referenced from other points of the code.

Author:

rpau

Method Summary

Modifier and Type	Method and Description
boolean	addBodyReference(SymbolReference bodyReference) Adds a symbol reference to this definition.
boolean	addUsage(SymbolReference usage) Adds a usage reference to this definition and updates the definition in that reference.
List<SymbolReference>	getBodyReferences() Returns the external references contained inside the body of this definition.
int	getScopeLevel() Returns the scope level where this definition is specified.
String	getSymbolName() Gets the symbol name
List<SymbolReference>	getUsages() Returns the references that represent usages to that definition.
void	setBodyReferences(List<SymbolReference> bodyReferences) Sets the external references contained inside the body of this definition.
void	setScopeLevel(int scopeLevel) Sets the scope level where this definition is specified.
void	setUsages(List<SymbolReference> usages) Sets the references that represent usages to that definition.

Methods inherited from interface org.walkmod.javalang.ast.ScopeAware

getMethodDefinitions, getTypeDefinitions, getVariableDefinitions

Method Detail

getUsages

List<SymbolReference> getUsages()

Returns the references that represent usages to that definition.

Returns:

the references that represent usages to that definition.

setUsages

void setUsages(List<SymbolReference> usages)

Sets the references that represent usages to that definition.

Parameters:

usages - references that represent usages to that definition.

addUsage

boolean addUsage(SymbolReference usage)

Adds a usage reference to this definition and updates the definition in that reference.

Parameters:

usage - reference to this definition.

Returns:

if the usage has been added.

getBodyReferences

List<SymbolReference> getBodyReferences()

Returns the external references contained inside the body of this definition. External references are references for definitions of an external scope.

Returns:

references for definitions of an external scope.

setBodyReferences

void setBodyReferences(List<SymbolReference> bodyReferences)

Sets the external references contained inside the body of this definition.

Parameters:

bodyReferences - external references contained inside the body of this definition.

addBodyReference

boolean addBodyReference(SymbolReference bodyReference)

Adds a symbol reference to this definition. If the reference is about an external definition (higher scope level), it will be added. Otherwise, it will be omitted.

Parameters:

bodyReference - the reference to add.

Returns:

true if the body reference has been added. False, otherwise.

getScopeLevel

int getScopeLevel()

Returns the scope level where this definition is specified. It starts from 0.

Returns:

the scope level where this definition is specified.

setScopeLevel

void setScopeLevel(int scopeLevel)

Sets the scope level where this definition is specified.

Parameters:

scopeLevel - the scope level where this definition is specified.

getSymbolName

String getSymbolName()

Gets the symbol name

Returns:

the symbol name