Package net.ssehub.easy.instantiation.core.model.buildlangModel

Class VariableFinder

java.lang.Object

net.ssehub.easy.instantiation.core.model.buildlangModel.VariableFinder

All Implemented Interfaces:

IBuildlangVisitor, IVisitor, IMatchVisitor, IVisitor, IExpressionVisitor

class VariableFinder
extends java.lang.Object
implements IBuildlangVisitor

Searches whether given variables are used.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	found
private java.util.Set<VariableDeclaration>	searchFor

Constructor Summary

Constructors

Constructor	Description
VariableFinder()	Creates a new variable finder.

Method Summary

Modifier and Type	Method	Description
void	addToSearch(VariableDeclaration searchFor)	Adds a variable to search for.
void	addToSearch(VariableDeclaration[] searchFor)	Adds variables to search for.
void	reset()	Resets this visitor.
java.lang.Object	visitAdvice(Advice advice)	Visits an advice.
java.lang.Object	visitAlternativeExpression(AlternativeExpression alt)	Visits an alternative.
java.lang.Object	visitArtifactMatchExpression(ArtifactMatchExpression expression)	Visits an artifact match expression.
java.lang.Object	visitBooleanMatchExpression(BooleanMatchExpression expression)	Visits a boolean match expression.
java.lang.Object	visitCallExpression(CallExpression call)	Visits a call node.
java.lang.Object	visitCollectionMatchExpression(CollectionMatchExpression expression)	Visits a collection match expression.
java.lang.Object	visitCompositeExpression(CompositeExpression ex)	Visits a composite expression.
java.lang.Object	visitCompound(Compound compound)	Visits a compound.
java.lang.Object	visitCompoundMatchExpression(CompoundMatchExpression expression)	Visits a compound match expression.
java.lang.Object	visitConstantExpression(ConstantExpression cst)	Visits a constant node.
java.lang.Object	visitContainerInitializerExpression(ContainerInitializerExpression ex)	Visits a container initializer expression.
java.lang.Object	visitExpression(Expression ex)	Visits an unspecified expression (in case of specialized nodes).
java.lang.Object	visitExpressionEvaluator(ExpressionEvaluator ex)	Visits an expression evaluator.
java.lang.Object	visitExpressionStatement(ExpressionStatement statement)	Visits a statement.
java.lang.Object	visitFieldAccessExpression(FieldAccessExpression ex)	Visits a field access expression.
java.lang.Object	visitForStatement(ForStatement stmt)	Visits a for statement.
java.lang.Object	visitInstantiateExpression(InstantiateExpression inst)	Visits an instantiate expression.
java.lang.Object	visitJoinExpression(JoinExpression ex)	Visits a join expression.
java.lang.Object	visitJoinVariableDeclaration(JoinVariableDeclaration decl)	Visits a join variable declaration.
java.lang.Object	visitLoadProperties(LoadProperties properties)	Visits a load properties directive.
java.lang.Object	visitMapExpression(MapExpression map)	Visits a map expression.
java.lang.Object	visitMultiAndExpression(MultiAndExpression ex)	Visits a multi-and expression.
java.lang.Object	visitParenthesisExpression(ParenthesisExpression par)	Visits a parenthesis node.
java.lang.Object	visitPathMatchExpression(PathMatchExpression expression)	Visits a path match expression.
java.lang.Object	visitResolvableOperationCallExpression(ResolvableOperationCallExpression ex)	Visits resolvable operation call expression (function pointer call).
java.lang.Object	visitResolvableOperationExpression(ResolvableOperationExpression ex)	Visits resolvable operation expression (function pointer resolution).
java.lang.Object	visitRule(Rule rule)	Visits a rule.
java.lang.Object	visitRule(VtlRule rule)	Visits a VTL mapping rule.
private void	visitRuleBlock(IRuleBlock block)	Visits and searches in a given rule block.
java.lang.Object	visitRuleCallExpression(RuleCallExpression ex)	Visits a rule call expression.
java.lang.Object	visitScript(Script script)	Visits a script.
java.lang.Object	visitStrategyCallExpression(StrategyCallExpression call)	Visits a strategy call node.
java.lang.Object	visitStringExpression(StringExpression ex)	Visits a string expression.
java.lang.Object	visitStringMatchExpression(StringMatchExpression expression)	Visits a string match expression.
java.lang.Object	visitTypedef(Typedef typedef)	Visits a typedef.
java.lang.Object	visitValueAssignmentExpression(ValueAssignmentExpression ex)	Visits a value assignment expression.
java.lang.Object	visitVariableDeclaration(VariableDeclaration var)	Visits a variable declaration.
java.lang.Object	visitVariableExpression(VariableExpression cst)	Visits a constant node.
java.lang.Object	visitVarModelIdentifierExpression(VarModelIdentifierExpression identifier)	Visits a variability model identifier.
java.lang.Object	visitVilTypeExpression(VilTypeExpression typeExpression)	Visits a VIL type expression.
java.lang.Object	visitWhileStatement(WhileStatement stmt)	Visits a while statement.
boolean	wasFound()	Returns whether at least one variable was found.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

searchFor

private java.util.Set<VariableDeclaration> searchFor

found

private boolean found

Constructor Detail

VariableFinder

public VariableFinder()

Creates a new variable finder.

Method Detail

addToSearch

public void addToSearch(VariableDeclaration searchFor)

Adds a variable to search for.

Parameters:

searchFor - the variable to search for

addToSearch

public void addToSearch(VariableDeclaration[] searchFor)

Adds variables to search for.

Parameters:

searchFor - the variables to add

reset

public void reset()

Resets this visitor.

wasFound

public boolean wasFound()

Returns whether at least one variable was found.

Returns:

true if at least one was found, false else

visitScript

public java.lang.Object visitScript(Script script)
                             throws VilException

Description copied from interface: IVisitor

Visits a script.

Specified by:

visitScript in interface IVisitor

Parameters:

script - the project instance

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitLoadProperties

public java.lang.Object visitLoadProperties(LoadProperties properties)
                                     throws VilException

Description copied from interface: IVisitor

Visits a load properties directive.

Specified by:

visitLoadProperties in interface IVisitor

Parameters:

properties - the load properties representation

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitStrategyCallExpression

public java.lang.Object visitStrategyCallExpression(StrategyCallExpression call)
                                             throws VilException

Description copied from interface: IVisitor

Visits a strategy call node.

Specified by:

visitStrategyCallExpression in interface IVisitor

Parameters:

call - the node

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitRuleCallExpression

public java.lang.Object visitRuleCallExpression(RuleCallExpression ex)
                                         throws VilException

Description copied from interface: IVisitor

Visits a rule call expression.

Specified by:

visitRuleCallExpression in interface IVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitJoinExpression

public java.lang.Object visitJoinExpression(JoinExpression ex)
                                     throws VilException

Description copied from interface: IVisitor

Visits a join expression.

Specified by:

visitJoinExpression in interface IVisitor

Parameters:

ex - the join expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitJoinVariableDeclaration

public java.lang.Object visitJoinVariableDeclaration(JoinVariableDeclaration decl)
                                              throws VilException

Description copied from interface: IVisitor

Visits a join variable declaration.

Specified by:

visitJoinVariableDeclaration in interface IVisitor

Parameters:

decl - the declaration

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitRuleBlock

private void visitRuleBlock(IRuleBlock block)
                     throws VilException

Visits and searches in a given rule block.

Parameters:

block - the block to search in

Throws:

VilException - if visiting fails

visitRule

public java.lang.Object visitRule(VtlRule rule)
                           throws VilException

Description copied from interface: IVisitor

Visits a VTL mapping rule.

Specified by:

visitRule in interface IVisitor

Parameters:

rule - the rule

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitRule

public java.lang.Object visitRule(Rule rule)
                           throws VilException

Description copied from interface: IVisitor

Visits a rule.

Specified by:

visitRule in interface IVisitor

Parameters:

rule - the rule

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitMapExpression

public java.lang.Object visitMapExpression(MapExpression map)
                                    throws VilException

Description copied from interface: IVisitor

Visits a map expression.

Specified by:

visitMapExpression in interface IVisitor

Parameters:

map - the expression to be visited

Returns:

the result of visiting the given expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitVariableDeclaration

public java.lang.Object visitVariableDeclaration(VariableDeclaration var)
                                          throws VilException

Description copied from interface: IVisitor

Visits a variable declaration.

Specified by:

visitVariableDeclaration in interface IVisitor

Parameters:

var - the variable declaration

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitCompound

public java.lang.Object visitCompound(Compound compound)
                               throws VilException

Description copied from interface: IVisitor

Visits a compound.

Specified by:

visitCompound in interface IVisitor

Parameters:

compound - the compound

Returns:

the result of visiting (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitAdvice

public java.lang.Object visitAdvice(Advice advice)
                             throws VilException

Description copied from interface: IVisitor

Visits an advice.

Specified by:

visitAdvice in interface IVisitor

Parameters:

advice - the advice to be visited

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitExpressionStatement

public java.lang.Object visitExpressionStatement(ExpressionStatement statement)
                                          throws VilException

Description copied from interface: IVisitor

Visits a statement.

Specified by:

visitExpressionStatement in interface IVisitor

Parameters:

statement - the statement

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitPathMatchExpression

public java.lang.Object visitPathMatchExpression(PathMatchExpression expression)
                                          throws VilException

Description copied from interface: IMatchVisitor

Visits a path match expression.

Specified by:

visitPathMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitBooleanMatchExpression

public java.lang.Object visitBooleanMatchExpression(BooleanMatchExpression expression)
                                             throws VilException

Description copied from interface: IMatchVisitor

Visits a boolean match expression.

Specified by:

visitBooleanMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitStringMatchExpression

public java.lang.Object visitStringMatchExpression(StringMatchExpression expression)
                                            throws VilException

Description copied from interface: IMatchVisitor

Visits a string match expression.

Specified by:

visitStringMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitArtifactMatchExpression

public java.lang.Object visitArtifactMatchExpression(ArtifactMatchExpression expression)
                                              throws VilException

Description copied from interface: IMatchVisitor

Visits an artifact match expression.

Specified by:

visitArtifactMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitCollectionMatchExpression

public java.lang.Object visitCollectionMatchExpression(CollectionMatchExpression expression)
                                                throws VilException

Description copied from interface: IMatchVisitor

Visits a collection match expression.

Specified by:

visitCollectionMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitParenthesisExpression

public java.lang.Object visitParenthesisExpression(ParenthesisExpression par)
                                            throws VilException

Description copied from interface: IExpressionVisitor

Visits a parenthesis node.

Specified by:

visitParenthesisExpression in interface IExpressionVisitor

Parameters:

par - the node

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitCallExpression

public java.lang.Object visitCallExpression(CallExpression call)
                                     throws VilException

Description copied from interface: IExpressionVisitor

Visits a call node.

Specified by:

visitCallExpression in interface IExpressionVisitor

Parameters:

call - the node

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitMultiAndExpression

public java.lang.Object visitMultiAndExpression(MultiAndExpression ex)
                                         throws VilException

Description copied from interface: IExpressionVisitor

Visits a multi-and expression.

Specified by:

visitMultiAndExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitConstantExpression

public java.lang.Object visitConstantExpression(ConstantExpression cst)
                                         throws VilException

Description copied from interface: IExpressionVisitor

Visits a constant node.

Specified by:

visitConstantExpression in interface IExpressionVisitor

Parameters:

cst - the node

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitStringExpression

public java.lang.Object visitStringExpression(StringExpression ex)
                                       throws VilException

Description copied from interface: IExpressionVisitor

Visits a string expression.

Specified by:

visitStringExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitVarModelIdentifierExpression

public java.lang.Object visitVarModelIdentifierExpression(VarModelIdentifierExpression identifier)
                                                   throws VilException

Description copied from interface: IExpressionVisitor

Visits a variability model identifier.

Specified by:

visitVarModelIdentifierExpression in interface IExpressionVisitor

Parameters:

identifier - the identifier

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitVilTypeExpression

public java.lang.Object visitVilTypeExpression(VilTypeExpression typeExpression)
                                        throws VilException

Description copied from interface: IExpressionVisitor

Visits a VIL type expression.

Specified by:

visitVilTypeExpression in interface IExpressionVisitor

Parameters:

typeExpression - the expression

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitVariableExpression

public java.lang.Object visitVariableExpression(VariableExpression cst)
                                         throws VilException

Description copied from interface: IExpressionVisitor

Visits a constant node.

Specified by:

visitVariableExpression in interface IExpressionVisitor

Parameters:

cst - the node

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitFieldAccessExpression

public java.lang.Object visitFieldAccessExpression(FieldAccessExpression ex)
                                            throws VilException

Description copied from interface: IExpressionVisitor

Visits a field access expression.

Specified by:

visitFieldAccessExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitExpression

public java.lang.Object visitExpression(Expression ex)
                                 throws VilException

Description copied from interface: IExpressionVisitor

Visits an unspecified expression (in case of specialized nodes).

Specified by:

visitExpression in interface IExpressionVisitor

Parameters:

ex - the node

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitValueAssignmentExpression

public java.lang.Object visitValueAssignmentExpression(ValueAssignmentExpression ex)
                                                throws VilException

Description copied from interface: IExpressionVisitor

Visits a value assignment expression.

Specified by:

visitValueAssignmentExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitExpressionEvaluator

public java.lang.Object visitExpressionEvaluator(ExpressionEvaluator ex)
                                          throws VilException

Description copied from interface: IExpressionVisitor

Visits an expression evaluator.

Specified by:

visitExpressionEvaluator in interface IExpressionVisitor

Parameters:

ex - the evaluator

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitContainerInitializerExpression

public java.lang.Object visitContainerInitializerExpression(ContainerInitializerExpression ex)
                                                     throws VilException

Description copied from interface: IExpressionVisitor

Visits a container initializer expression.

Specified by:

visitContainerInitializerExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitInstantiateExpression

public java.lang.Object visitInstantiateExpression(InstantiateExpression inst)
                                            throws VilException

Description copied from interface: IVisitor

Visits an instantiate expression.

Specified by:

visitInstantiateExpression in interface IVisitor

Parameters:

inst - the instantiation expression

Returns:

the result of visiting the given expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitAlternativeExpression

public java.lang.Object visitAlternativeExpression(AlternativeExpression alt)
                                            throws VilException

Description copied from interface: IVisitor

Visits an alternative.

Specified by:

visitAlternativeExpression in interface IVisitor

Parameters:

alt - the alternative

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitCompositeExpression

public java.lang.Object visitCompositeExpression(CompositeExpression ex)
                                          throws VilException

Description copied from interface: IExpressionVisitor

Visits a composite expression.

Specified by:

visitCompositeExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement

Throws:

VilException - in case that visiting fails (e.g., execution)

visitCompoundMatchExpression

public java.lang.Object visitCompoundMatchExpression(CompoundMatchExpression expression)
                                              throws VilException

Description copied from interface: IMatchVisitor

Visits a compound match expression.

Specified by:

visitCompoundMatchExpression in interface IMatchVisitor

Parameters:

expression - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitResolvableOperationExpression

public java.lang.Object visitResolvableOperationExpression(ResolvableOperationExpression ex)
                                                    throws VilException

Description copied from interface: IExpressionVisitor

Visits resolvable operation expression (function pointer resolution).

Specified by:

visitResolvableOperationExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitResolvableOperationCallExpression

public java.lang.Object visitResolvableOperationCallExpression(ResolvableOperationCallExpression ex)
                                                        throws VilException

Description copied from interface: IExpressionVisitor

Visits resolvable operation call expression (function pointer call).

Specified by:

visitResolvableOperationCallExpression in interface IExpressionVisitor

Parameters:

ex - the expression

Returns:

the result of visiting the given statement (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitTypedef

public java.lang.Object visitTypedef(Typedef typedef)
                              throws VilException

Description copied from interface: IVisitor

Visits a typedef.

Specified by:

visitTypedef in interface IVisitor

Parameters:

typedef - the typedef

Returns:

the result of visiting (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitWhileStatement

public java.lang.Object visitWhileStatement(WhileStatement stmt)
                                     throws VilException

Description copied from interface: IVisitor

Visits a while statement.

Specified by:

visitWhileStatement in interface IVisitor

Parameters:

stmt - the statement to be visited

Returns:

the result of visiting the given expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

visitForStatement

public java.lang.Object visitForStatement(ForStatement stmt)
                                   throws VilException

Description copied from interface: IVisitor

Visits a for statement.

Specified by:

visitForStatement in interface IVisitor

Parameters:

stmt - the statement to be visited

Returns:

the result of visiting the given expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)