org.walkmod.javalang.ast.body

Class MethodDeclaration

java.lang.Object

org.walkmod.javalang.ast.Node

org.walkmod.javalang.ast.body.BodyDeclaration

org.walkmod.javalang.ast.body.MethodDeclaration

All Implemented Interfaces:

Serializable, Cloneable, ScopeAware, SymbolDataAware<MethodSymbolData>, SymbolDefinition, org.walkmod.merger.IdentificableNode, org.walkmod.merger.Mergeable<MethodDeclaration>, org.walkmod.modelchecker.ConstrainedElement

public final class MethodDeclaration
extends BodyDeclaration
implements org.walkmod.merger.Mergeable<MethodDeclaration>, SymbolDataAware<MethodSymbolData>, SymbolDefinition

Author:

Julio Vilmar Gesser

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MethodDeclaration()
MethodDeclaration(int beginLine, int beginColumn, int endLine, int endColumn, JavadocComment javaDoc, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ClassOrInterfaceType> throws_, BlockStmt block)
MethodDeclaration(int beginLine, int beginColumn, int endLine, int endColumn, JavadocComment javaDoc, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ClassOrInterfaceType> throws_, BlockStmt block, boolean isDefault)
MethodDeclaration(int modifiers, Type type, String name)
MethodDeclaration(int modifiers, Type type, String name, List<Parameter> parameters)
MethodDeclaration(JavadocComment javaDoc, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ClassOrInterfaceType> throws_, BlockStmt block)
MethodDeclaration(JavadocComment javaDoc, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ClassOrInterfaceType> throws_, BlockStmt block, boolean isDefault)

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
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.
MethodDeclaration	clone()
int	getArrayCount()
BlockStmt	getBody()
List<SymbolReference>	getBodyReferences() Returns the external references contained inside the body of this definition.
List<Node>	getChildren()
Comparator<?>	getIdentityComparator()
int	getModifiers() Return the modifiers of this member declaration.
String	getName()
List<Parameter>	getParameters()
int	getScopeLevel() Returns the scope level where this definition is specified.
MethodSymbolData	getSymbolData() Returns the symbol data related to a given node.
String	getSymbolName() Gets the symbol name
List<ClassOrInterfaceType>	getThrows()
Type	getType()
Map<String,SymbolDefinition>	getTypeDefinitions() Gets the available variables
List<TypeParameter>	getTypeParameters()
List<SymbolReference>	getUsages() Returns the references that represent usages to that definition.
Map<String,SymbolDefinition>	getVariableDefinitions() Gets the available variables
boolean	isDefault()
void	merge(MethodDeclaration remote, org.walkmod.merger.MergeEngine configuration)
boolean	removeChild(Node child)
boolean	replaceChildNode(Node oldChild, Node newChild)
void	setArrayCount(int arrayCount)
void	setBody(BlockStmt body)
void	setBodyReferences(List<SymbolReference> bodyReferences) Sets the external references contained inside the body of this definition.
void	setDefault(boolean isDefault)
void	setModifiers(int modifiers)
void	setName(String name)
void	setParameters(List<Parameter> parameters)
void	setScopeLevel(int scopeLevel) Sets the scope level where this definition is specified.
void	setSymbolData(MethodSymbolData symbolData) Sets the symbol data from a semantic analyzer.
void	setThrows(List<ClassOrInterfaceType> throws_)
void	setType(Type type)
void	setTypeParameters(List<TypeParameter> typeParameters)
void	setUsages(List<SymbolReference> usages) Sets the references that represent usages to that definition.

Methods inherited from class org.walkmod.javalang.ast.body.BodyDeclaration

getAnnotations, getJavaDoc, getMethodDefinitions, merge, setAnnotations, setJavaDoc

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

check, 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

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

getMethodDefinitions

Constructor Detail

MethodDeclaration

public MethodDeclaration()

MethodDeclaration

public MethodDeclaration(int modifiers,
                         Type type,
                         String name)

MethodDeclaration

public MethodDeclaration(int modifiers,
                         Type type,
                         String name,
                         List<Parameter> parameters)

MethodDeclaration

public MethodDeclaration(JavadocComment javaDoc,
                         int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         List<ClassOrInterfaceType> throws_,
                         BlockStmt block)

MethodDeclaration

public MethodDeclaration(JavadocComment javaDoc,
                         int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         List<ClassOrInterfaceType> throws_,
                         BlockStmt block,
                         boolean isDefault)

MethodDeclaration

public MethodDeclaration(int beginLine,
                         int beginColumn,
                         int endLine,
                         int endColumn,
                         JavadocComment javaDoc,
                         int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         List<ClassOrInterfaceType> throws_,
                         BlockStmt block)

MethodDeclaration

public MethodDeclaration(int beginLine,
                         int beginColumn,
                         int endLine,
                         int endColumn,
                         JavadocComment javaDoc,
                         int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         List<ClassOrInterfaceType> throws_,
                         BlockStmt block,
                         boolean isDefault)

Method Detail

removeChild

public boolean removeChild(Node child)

Overrides:

removeChild in class BodyDeclaration

getChildren

public List<Node> getChildren()

Overrides:

getChildren in class BodyDeclaration

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

R - the type the return value of the visitor

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor

Returns:

the result of the visit

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor

getArrayCount

public int getArrayCount()

getBody

public BlockStmt getBody()

getModifiers

public int getModifiers()

Return the modifiers of this member declaration.

Returns:

modifiers

See Also:

ModifierSet

getName

public String getName()

getParameters

public List<Parameter> getParameters()

getThrows

public List<ClassOrInterfaceType> getThrows()

getType

public Type getType()

getTypeParameters

public List<TypeParameter> getTypeParameters()

setArrayCount

public void setArrayCount(int arrayCount)

setBody

public void setBody(BlockStmt body)

setModifiers

public void setModifiers(int modifiers)

setName

public void setName(String name)

setParameters

public void setParameters(List<Parameter> parameters)

setThrows

public void setThrows(List<ClassOrInterfaceType> throws_)

setType

public void setType(Type type)

setTypeParameters

public void setTypeParameters(List<TypeParameter> typeParameters)

getIdentityComparator

public Comparator<?> getIdentityComparator()

Specified by:

getIdentityComparator in interface org.walkmod.merger.IdentificableNode

merge

public void merge(MethodDeclaration remote,
                  org.walkmod.merger.MergeEngine configuration)

Specified by:

merge in interface org.walkmod.merger.Mergeable<MethodDeclaration>

isDefault

public boolean isDefault()

setDefault

public void setDefault(boolean isDefault)

getSymbolData

public MethodSymbolData 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<MethodSymbolData>

Returns:

the symbol data

setSymbolData

public void setSymbolData(MethodSymbolData symbolData)

Description copied from interface: SymbolDataAware

Sets the symbol data from a semantic analyzer.

Specified by:

setSymbolData in interface SymbolDataAware<MethodSymbolData>

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.

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.

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.

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.

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.

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.

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)

Overrides:

replaceChildNode in class BodyDeclaration

clone

public MethodDeclaration clone()
                        throws CloneNotSupportedException

Specified by:

clone in class Node

Throws:

CloneNotSupportedException

getVariableDefinitions

public Map<String,SymbolDefinition> getVariableDefinitions()

Description copied from interface: ScopeAware

Gets the available variables

Specified by:

getVariableDefinitions in interface ScopeAware

Overrides:

getVariableDefinitions in class BodyDeclaration

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

Overrides:

getTypeDefinitions in class BodyDeclaration

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