|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.puppycrawl.tools.checkstyle.api.AutomaticBean com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck com.puppycrawl.tools.checkstyle.TreeWalker
Responsible for walking an abstract syntax tree and notifying interested checks at each each node.
Constructor Summary | |
TreeWalker()
Creates a new TreeWalker instance. |
Method Summary | |
void |
destroy()
Cleans up the object. |
void |
finishLocalSetup()
Provides a hook to finish the part of this compoent's setup that was not handled by the bean introspection. |
static DetailAST |
parse(FileContents aContents)
Static helper method to parses a Java source file. |
void |
process(java.io.File[] aFiles)
Processes a set of files and fires errors to the MessageDispatcher. |
void |
setCacheFile(java.lang.String aFileName)
|
void |
setClassLoader(java.lang.ClassLoader aClassLoader)
|
void |
setModuleFactory(ModuleFactory aModuleFactory)
Sets the module factory for creating child modules (Checks). |
void |
setTabWidth(int aTabWidth)
|
void |
setupChild(Configuration aChildConf)
Instantiates, configures and registers a Check that is specified in the provided configuration. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck |
filter, fireErrors, getCharset, getMessageCollector, getMessageDispatcher, log, log, setCharset, setFileExtensions, setMessageDispatcher |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
configure, contextualize, getConfiguration |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable |
configure |
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable |
contextualize |
Constructor Detail |
public TreeWalker()
TreeWalker
instance.
Method Detail |
public void setTabWidth(int aTabWidth)
aTabWidth
- the distance between tab stopspublic void setCacheFile(java.lang.String aFileName)
aFileName
- the cache filepublic void setClassLoader(java.lang.ClassLoader aClassLoader)
aClassLoader
- class loader to resolve classes with.public void setModuleFactory(ModuleFactory aModuleFactory)
aModuleFactory
- the factorypublic void finishLocalSetup()
AutomaticBean
The default implementation does nothing.
finishLocalSetup
in class AutomaticBean
Configurable
public void setupChild(Configuration aChildConf) throws CheckstyleException
setupChild
in class AutomaticBean
aChildConf
- a child of this component's Configuration
CheckstyleException
- if there is a configuration error.AutomaticBean
public static DetailAST parse(FileContents aContents) throws antlr.RecognitionException, antlr.TokenStreamException
aContents
- contains the contents of the file
antlr.RecognitionException
- if parsing failed
antlr.TokenStreamException
- if lexing failedpublic void process(java.io.File[] aFiles)
FileSetCheck
aFiles
- the files to be audited.FileSetCheck
public void destroy()
FileSetCheck
destroy
in interface FileSetCheck
destroy
in class AbstractFileSetCheck
FileSetCheck
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |