spoon.reflect.visitor.filter

Class PotentialVariableDeclarationFunction

java.lang.Object

spoon.reflect.visitor.filter.PotentialVariableDeclarationFunction

All Implemented Interfaces:

CtConsumableFunction<CtElement>, CtQueryAware

public class PotentialVariableDeclarationFunction
extends java.lang.Object
implements CtConsumableFunction<CtElement>, CtQueryAware

This mapping function searches for all CtVariable instances, which might be a declaration of an input CtElement.
It can be used to search for variable declarations of variable references and for detection of variable name conflicts
It returns CtLocalVariable instances, or it returns CtCatchVariable instances of catch blocks, or i returns CtParameter instances of methods, lambdas and catch blocks. or it returns CtField instances from wrapping classes and their super classes too.
The elements are visited in the following order: first elements are thought in the nearest parent blocks, then in the fields of wrapping classes, then in the fields of super classes, etc.
Example: Search for all potential CtVariable declarations

 
 CtVariableReference varRef = ...;
 varRef.map(new PotentialVariableDeclarationFunction()).forEach(...process result...);
 
 

Example: Search for CtVariable declaration of variable named `varName` in scope "scope"

 
 CtElement scope = ...;
 String varName = "anVariableName";
 CtVariable varOrNull = scope.map(new PotentialVariableDeclarationFunction(varName)).first();
 
 

Constructor Summary

Constructors

Constructor and Description
PotentialVariableDeclarationFunction()
PotentialVariableDeclarationFunction(java.lang.String variableName) Searches for a variable with exact name.

Method Summary

Modifier and Type	Method and Description
void	apply(CtElement input, CtConsumer<java.lang.Object> outputConsumer) Evaluates the function on the given input.
boolean	isTypeOnTheWay() This method provides access to current state of this function.
void	setQuery(CtQuery query) This method is called when the filter/function is added as a step to a CtQuery by the query engine (CtQueryImpl).

Methods inherited from class java.lang.Object

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

Constructor Detail

PotentialVariableDeclarationFunction

public PotentialVariableDeclarationFunction()

PotentialVariableDeclarationFunction

public PotentialVariableDeclarationFunction(java.lang.String variableName)

Searches for a variable with exact name.

Parameters:

variableName -

Method Detail

apply

public void apply(CtElement input,
                  CtConsumer<java.lang.Object> outputConsumer)

Description copied from interface: CtConsumableFunction

Evaluates the function on the given input.

Specified by:

apply in interface CtConsumableFunction<CtElement>

Parameters:

input - the input of the function

outputConsumer - the consumer which accepts the results of this function.

isTypeOnTheWay

public boolean isTypeOnTheWay()

This method provides access to current state of this function. It is intended to be called by other mapping functions at query processing time or after query is finished.

Returns:

true if there is an local class on the way from the input of this mapping function to the actually found potential variable declaration

setQuery

public void setQuery(CtQuery query)

Description copied from interface: CtQueryAware

This method is called when the filter/function is added as a step to a CtQuery by the query engine (CtQueryImpl).

Specified by:

setQuery in interface CtQueryAware

Parameters:

query - an instance registering this function/filter.