Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.org.codenarc.rule
[Java] Class AbstractSharedAstVisitorRule

java.lang.Object
  java.org.codenarc.rule.AbstractRule
      java.org.codenarc.rule.AbstractAstVisitorRule
          java.org.codenarc.rule.AbstractSharedAstVisitorRule

public abstract class AbstractSharedAstVisitorRule
extends AbstractAstVisitorRule

Abstract superclass for Rules that use a single, shared AstVisitor across all ClassNodes in a source (file).

Authors:
Chris Mair

Field Summary
 
Fields inherited from class AbstractAstVisitorRule
DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
 
Method Summary
void applyTo(SourceCode sourceCode, List violations)

protected void applyVisitor(AstVisitor visitor, SourceCode sourceCode)

protected AstVisitor getAstVisitor(SourceCode sourceCode)

Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.
protected List getViolations(AstVisitor astVisitor, SourceCode sourceCode)

 
Methods inherited from class AbstractAstVisitorRule
applyTo, getApplyToClassNames, getAstVisitor, getAstVisitorClass, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo
 
Methods inherited from class AbstractRule
applyTo, applyTo, createViolation, createViolation, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getName, getPriority, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setName, setPriority, setViolationMessage, toString, validate
 

Method Detail

applyTo

@Override
public void applyTo(SourceCode sourceCode, List violations)

applyVisitor

protected void applyVisitor(AstVisitor visitor, SourceCode sourceCode)

getAstVisitor

protected AstVisitor getAstVisitor(SourceCode sourceCode)
Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.

getViolations

protected List getViolations(AstVisitor astVisitor, SourceCode sourceCode)

 

Groovy Documentation