org.walkmod.javalang.ast.body

Class EnumConstantDeclaration

java.lang.Object

org.walkmod.javalang.ast.Node

org.walkmod.javalang.ast.body.BodyDeclaration

org.walkmod.javalang.ast.body.EnumConstantDeclaration

All Implemented Interfaces:

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

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

Author:

Julio Vilmar Gesser

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumConstantDeclaration()
EnumConstantDeclaration(int beginLine, int beginColumn, int endLine, int endColumn, JavadocComment javaDoc, List<AnnotationExpr> annotations, String name, List<Expression> args, List<BodyDeclaration> classBody)
EnumConstantDeclaration(JavadocComment javaDoc, List<AnnotationExpr> annotations, String name, List<Expression> args, List<BodyDeclaration> classBody)
EnumConstantDeclaration(String name)

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.
EnumConstantDeclaration	clone()
List<Expression>	getArgs()
List<SymbolReference>	getBodyReferences() Returns the external references contained inside the body of this definition.
List<Node>	getChildren()
List<BodyDeclaration>	getClassBody()
Comparator<?>	getIdentityComparator()
String	getName()
EnumDeclaration	getParentNode()
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
List<SymbolReference>	getUsages() Returns the references that represent usages to that definition.
void	merge(EnumConstantDeclaration remote, org.walkmod.merger.MergeEngine configuration)
boolean	removeChild(Node child)
boolean	replaceChildNode(Node oldChild, Node newChild)
void	setArgs(List<Expression> args)
void	setBodyReferences(List<SymbolReference> bodyReferences) Sets the external references contained inside the body of this definition.
void	setClassBody(List<BodyDeclaration> classBody)
void	setName(String name)
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.body.BodyDeclaration

getAnnotations, getJavaDoc, getMethodDefinitions, getTypeDefinitions, getVariableDefinitions, 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, 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, getTypeDefinitions, getVariableDefinitions

Constructor Detail

EnumConstantDeclaration

public EnumConstantDeclaration()

EnumConstantDeclaration

public EnumConstantDeclaration(String name)

EnumConstantDeclaration

public EnumConstantDeclaration(JavadocComment javaDoc,
                               List<AnnotationExpr> annotations,
                               String name,
                               List<Expression> args,
                               List<BodyDeclaration> classBody)

EnumConstantDeclaration

public EnumConstantDeclaration(int beginLine,
                               int beginColumn,
                               int endLine,
                               int endColumn,
                               JavadocComment javaDoc,
                               List<AnnotationExpr> annotations,
                               String name,
                               List<Expression> args,
                               List<BodyDeclaration> classBody)

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

getArgs

public List<Expression> getArgs()

getClassBody

public List<BodyDeclaration> getClassBody()

getName

public String getName()

setArgs

public void setArgs(List<Expression> args)

setClassBody

public void setClassBody(List<BodyDeclaration> classBody)

setName

public void setName(String name)

getIdentityComparator

public Comparator<?> getIdentityComparator()

Specified by:

getIdentityComparator in interface org.walkmod.merger.IdentificableNode

merge

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

Specified by:

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

getParentNode

public EnumDeclaration getParentNode()

Overrides:

getParentNode in class Node

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.

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.

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.

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.

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.

replaceChildNode

public boolean replaceChildNode(Node oldChild,
                                Node newChild)

Overrides:

replaceChildNode in class BodyDeclaration

clone

public EnumConstantDeclaration clone()
                              throws CloneNotSupportedException

Specified by:

clone in class Node

Throws:

CloneNotSupportedException

getSymbolName

public String getSymbolName()

Description copied from interface: SymbolDefinition

Gets the symbol name

Specified by:

getSymbolName in interface SymbolDefinition

Returns:

the symbol name