org.walkmod.javalang.ast

Class ImportDeclaration

java.lang.Object

org.walkmod.javalang.ast.Node

org.walkmod.javalang.ast.ImportDeclaration

All Implemented Interfaces:

Serializable, Cloneable, ScopeAware, SymbolDefinition, org.walkmod.merger.IdentificableNode, org.walkmod.merger.Mergeable<ImportDeclaration>, org.walkmod.modelchecker.ConstrainedElement

public final class ImportDeclaration
extends Node
implements org.walkmod.merger.Mergeable<ImportDeclaration>, SymbolDefinition

This class represents a import declaration. Imports are optional for the CompilationUnit.

The ImportDeclaration is constructed following the syntax:

ImportDeclaration

::=

"import" ( "static" )? NameExpr ( "." "*" )? ";"

Author:

Julio Vilmar Gesser

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImportDeclaration()
ImportDeclaration(int beginLine, int beginColumn, int endLine, int endColumn, NameExpr name, boolean isStatic, boolean isAsterisk)
ImportDeclaration(NameExpr name, boolean isStatic, boolean isAsterisk)

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.
ImportDeclaration	clone()
List<SymbolReference>	getBodyReferences() Returns the external references contained inside the body of this definition.
List<Node>	getChildren()
Comparator<?>	getIdentityComparator()
Map<String,List<SymbolDefinition>>	getMethodDefinitions() Gets the available methods
NameExpr	getName() Retrieves the name of the import.
int	getScopeLevel() Returns the scope level where this definition is specified.
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	isAsterisk() Return if the import ends with "*".
boolean	isStatic() Return if the import is static.
void	merge(ImportDeclaration t1, org.walkmod.merger.MergeEngine configuration)
boolean	removeChild(Node child)
boolean	replaceChildNode(Node oldChild, Node newChild)
void	setAsterisk(boolean asterisk) Sets if this import is asterisk.
void	setBodyReferences(List<SymbolReference> bodyReferences) Sets the external references contained inside the body of this definition.
void	setName(NameExpr name) Sets the name this import.
void	setScopeLevel(int scopeLevel) Sets the scope level where this definition is specified.
void	setStatic(boolean static_) Sets if this import is static.
void	setUsages(List<SymbolReference> usages) Sets the references that represent usages to that definition.

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

Constructor Detail

ImportDeclaration

public ImportDeclaration()

ImportDeclaration

public ImportDeclaration(NameExpr name,
                         boolean isStatic,
                         boolean isAsterisk)

ImportDeclaration

public ImportDeclaration(int beginLine,
                         int beginColumn,
                         int endLine,
                         int endColumn,
                         NameExpr name,
                         boolean isStatic,
                         boolean isAsterisk)

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

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

getName

public NameExpr getName()

Retrieves the name of the import.

Returns:

the name of the import

isAsterisk

public boolean isAsterisk()

Return if the import ends with "*".

Returns:

true if the import ends with "*", false otherwise

isStatic

public boolean isStatic()

Return if the import is static.

Returns:

true if the import is static, false otherwise

setAsterisk

public void setAsterisk(boolean asterisk)

Sets if this import is asterisk.

Parameters:

asterisk - true if this import is asterisk

setName

public void setName(NameExpr name)

Sets the name this import.

Parameters:

name - the name to set

setStatic

public void setStatic(boolean static_)

Sets if this import is static.

Parameters:

static_ - true if this import is static

getIdentityComparator

public Comparator<?> getIdentityComparator()

Specified by:

getIdentityComparator in interface org.walkmod.merger.IdentificableNode

merge

public void merge(ImportDeclaration t1,
                  org.walkmod.merger.MergeEngine configuration)

Specified by:

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

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)

Specified by:

replaceChildNode in class Node

clone

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

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