org.walkmod.javalang.ast.body

Class BaseParameter

java.lang.Object

org.walkmod.javalang.ast.Node

org.walkmod.javalang.ast.body.BaseParameter

All Implemented Interfaces:

Serializable, Cloneable, ScopeAware, SymbolDataAware<SymbolData>, SymbolDefinition, org.walkmod.modelchecker.ConstrainedElement

Direct Known Subclasses:

MultiTypeParameter, Parameter

public abstract class BaseParameter
extends Node
implements SymbolDataAware<SymbolData>, SymbolDefinition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseParameter()
BaseParameter(int beginLine, int beginColumn, int endLine, int endColumn, int modifiers, List<AnnotationExpr> annotations, VariableDeclaratorId id)
BaseParameter(int modifiers, List<AnnotationExpr> annotations, VariableDeclaratorId id)
BaseParameter(int modifiers, VariableDeclaratorId id)
BaseParameter(VariableDeclaratorId id)

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<AnnotationExpr>	getAnnotations()
List<SymbolReference>	getBodyReferences() Returns the external references contained inside the body of this definition.
List<Node>	getChildren()
VariableDeclaratorId	getId()
Map<String,List<SymbolDefinition>>	getMethodDefinitions() Gets the available methods
int	getModifiers() Return the modifiers of this parameter declaration.
int	getScopeLevel() Returns the scope level where this definition is specified.
SymbolData	getSymbolData() Returns the symbol data related to a given node.
String	getSymbolName() Gets the symbol name
Map<String,SymbolDefinition>	getTypeDefinitions() Gets the available variables
List<SymbolReference>	getUsages() Returns the references that represent usages to that definition.
Map<String,SymbolDefinition>	getVariableDefinitions() Gets the available variables
boolean	removeChild(Node child)
boolean	replaceChildNode(Node oldChild, Node newChild)
void	setAnnotations(List<AnnotationExpr> annotations)
void	setBodyReferences(List<SymbolReference> bodyReferences) Sets the external references contained inside the body of this definition.
void	setId(VariableDeclaratorId id)
void	setModifiers(int modifiers)
void	setScopeLevel(int scopeLevel) Sets the scope level where this definition is specified.
void	setSymbolData(SymbolData symbolData) Sets the symbol data from a semantic analyzer.
void	setUsages(List<SymbolReference> usages) Sets the references that represent usages to that definition.

Methods inherited from class org.walkmod.javalang.ast.Node

accept, accept, check, clone, clone, clone, contains, diableConstraints, enableConstraints, equals, getBeginColumn, getBeginLine, getCommonAncestor, getConstraints, getData, getEndColumn, getEndLine, getParentNode, getPrettySource, getPrettySource, hashCode, isAncestorOf, isInEqualLocation, isNewNode, isPreviousThan, remove, replaceChildNodeInList, setAsParentNodeOf, setAsParentNodeOf, setBeginColumn, setBeginLine, setConstraints, setData, setEndColumn, setEndLine, toString, updateReferences

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseParameter

public BaseParameter()

BaseParameter

public BaseParameter(VariableDeclaratorId id)

BaseParameter

public BaseParameter(int modifiers,
                     VariableDeclaratorId id)

BaseParameter

public BaseParameter(int modifiers,
                     List<AnnotationExpr> annotations,
                     VariableDeclaratorId id)

BaseParameter

public BaseParameter(int beginLine,
                     int beginColumn,
                     int endLine,
                     int endColumn,
                     int modifiers,
                     List<AnnotationExpr> annotations,
                     VariableDeclaratorId id)

Method Detail

removeChild

public boolean removeChild(Node child)

Specified by:

removeChild in class Node

getChildren

public List<Node> getChildren()

Specified by:

getChildren in class Node

getAnnotations

public List<AnnotationExpr> getAnnotations()

getId

public VariableDeclaratorId getId()

getModifiers

public int getModifiers()

Return the modifiers of this parameter declaration.

Returns:

modifiers

See Also:

ModifierSet

setAnnotations

public void setAnnotations(List<AnnotationExpr> annotations)

setId

public void setId(VariableDeclaratorId id)

setModifiers

public void setModifiers(int modifiers)

getSymbolData

public SymbolData getSymbolData()

Description copied from interface: SymbolDataAware

Returns the symbol data related to a given node. It is null if the node value is the null literal or does not represent any valid information. In case of statements nodes, it corresponds to the returned value, if exists.

Specified by:

getSymbolData in interface SymbolDataAware<SymbolData>

Returns:

the symbol data

setSymbolData

public void setSymbolData(SymbolData symbolData)

Description copied from interface: SymbolDataAware

Sets the symbol data from a semantic analyzer.

Specified by:

setSymbolData in interface SymbolDataAware<SymbolData>

Parameters:

symbolData - the symbol data.

getUsages

public List<SymbolReference> getUsages()

Description copied from interface: SymbolDefinition

Returns the references that represent usages to that definition.

Specified by:

getUsages in interface SymbolDefinition

Returns:

the references that represent usages to that definition.

getBodyReferences

public List<SymbolReference> getBodyReferences()

Description copied from interface: SymbolDefinition

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

Specified by:

getBodyReferences in interface SymbolDefinition

Returns:

references for definitions of an external scope.

setUsages

public void setUsages(List<SymbolReference> usages)

Description copied from interface: SymbolDefinition

Sets the references that represent usages to that definition.

Specified by:

setUsages in interface SymbolDefinition

Parameters:

usages - references that represent usages to that definition.

setBodyReferences

public void setBodyReferences(List<SymbolReference> bodyReferences)

Description copied from interface: SymbolDefinition

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

Specified by:

setBodyReferences in interface SymbolDefinition

Parameters:

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

addBodyReference

public boolean addBodyReference(SymbolReference bodyReference)

Description copied from interface: SymbolDefinition

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.

Specified by:

addBodyReference in interface SymbolDefinition

Parameters:

bodyReference - the reference to add.

Returns:

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

getScopeLevel

public int getScopeLevel()

Description copied from interface: SymbolDefinition

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

Specified by:

getScopeLevel in interface SymbolDefinition

Returns:

the scope level where this definition is specified.

setScopeLevel

public void setScopeLevel(int scopeLevel)

Description copied from interface: SymbolDefinition

Sets the scope level where this definition is specified.

Specified by:

setScopeLevel in interface SymbolDefinition

Parameters:

scopeLevel - the scope level where this definition is specified.

addUsage

public boolean addUsage(SymbolReference usage)

Description copied from interface: SymbolDefinition

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

Specified by:

addUsage in interface SymbolDefinition

Parameters:

usage - reference to this definition.

Returns:

if the usage has been added.

replaceChildNode

public boolean replaceChildNode(Node oldChild,
                                Node newChild)

Specified by:

replaceChildNode in class Node

getVariableDefinitions

public Map<String,SymbolDefinition> getVariableDefinitions()

Description copied from interface: ScopeAware

Gets the available variables

Specified by:

getVariableDefinitions in interface ScopeAware

Returns:

the available variables

getMethodDefinitions

public Map<String,List<SymbolDefinition>> getMethodDefinitions()

Description copied from interface: ScopeAware

Gets the available methods

Specified by:

getMethodDefinitions in interface ScopeAware

Returns:

the available variables

getTypeDefinitions

public Map<String,SymbolDefinition> getTypeDefinitions()

Description copied from interface: ScopeAware

Gets the available variables

Specified by:

getTypeDefinitions in interface ScopeAware

Returns:

the available variables

getSymbolName

public String getSymbolName()

Description copied from interface: SymbolDefinition

Gets the symbol name

Specified by:

getSymbolName in interface SymbolDefinition

Returns:

the symbol name