|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sourceforge.pmd.AbstractRuleChainVisitor
public abstract class AbstractRuleChainVisitor
This is a base class for RuleChainVisitor implementations which extracts interesting nodes from an AST, and lets each Rule visit the nodes it has expressed interest in.
| Field Summary | |
|---|---|
protected java.util.Map<java.lang.String,java.util.List<SimpleNode>> |
nodeNameToNodes
This is a mapping from node names to nodes instances for the current AST. |
protected java.util.Map<RuleSet,java.util.List<Rule>> |
ruleSetRules
These are all the rules participating in the RuleChain, grouped by RuleSet. |
| Constructor Summary | |
|---|---|
AbstractRuleChainVisitor()
|
|
| Method Summary | |
|---|---|
void |
add(RuleSet ruleSet,
Rule rule)
Add the given rule to the visitor. |
protected void |
clear()
Clears the internal data structure used to manage the nodes visited between visiting different ASTs. |
protected void |
indexNode(SimpleNode node)
Index a single node for visitation by rules. |
protected abstract void |
indexNodes(java.util.List<CompilationUnit> astCompilationUnits,
RuleContext ctx)
Index all nodes for visitation by rules. |
protected void |
initialize()
Initialize the RuleChainVisitor to be ready to perform visitations. |
protected abstract void |
visit(Rule rule,
SimpleNode node,
RuleContext ctx)
Visit the given rule to the given node. |
void |
visitAll(java.util.List<CompilationUnit> astCompilationUnits,
RuleContext ctx)
Visit all the given ASTCompilationUnits provided using the given RuleContext. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.util.Map<RuleSet,java.util.List<Rule>> ruleSetRules
protected java.util.Map<java.lang.String,java.util.List<SimpleNode>> nodeNameToNodes
| Constructor Detail |
|---|
public AbstractRuleChainVisitor()
| Method Detail |
|---|
public void add(RuleSet ruleSet,
Rule rule)
RuleChainVisitor
add in interface RuleChainVisitorruleSet - The RuleSet to which the rule belongs.rule - The rule to add.RuleChainVisitor.add(RuleSet, Rule)
public void visitAll(java.util.List<CompilationUnit> astCompilationUnits,
RuleContext ctx)
RuleChainVisitor
visitAll in interface RuleChainVisitorastCompilationUnits - The ASTCompilationUnits to visit.ctx - The RuleContext.RuleChainVisitor.visitAll(List, RuleContext)
protected abstract void visit(Rule rule,
SimpleNode node,
RuleContext ctx)
protected abstract void indexNodes(java.util.List<CompilationUnit> astCompilationUnits,
RuleContext ctx)
protected void indexNode(SimpleNode node)
protected void initialize()
protected void clear()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||