com.puppycrawl.tools.checkstyle

Class TreeWalker

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

All Implemented Interfaces:

Configurable, Contextualizable, ExternalResourceHolder, FileSetCheck

public final class TreeWalker
extends AbstractFileSetCheck
implements ExternalResourceHolder

Responsible for walking an abstract syntax tree and notifying interested checks at each each node.

Author:

Oliver Burn

Constructor Summary

Constructors

Constructor and Description
TreeWalker() Creates a new TreeWalker instance.

Method Summary

Modifier and Type	Method and Description
void	destroy() Cleans up the object.
void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
Set<String>	getExternalResourceLocations() Returns a set of external configuration resource locations which are used by the module.
static DetailAST	parse(FileContents contents) Static helper method to parses a Java source file.
static DetailAST	parseWithComments(FileContents contents) Parses Java source file.
protected void	processFiltered(File file, List<String> lines) Called to process a file that matches the specified file extensions.
void	setCacheFile(String fileName) Deprecated. Use Checker.setCacheFile(java.lang.String) instead. It does not do anything now. We just keep the setter for transition period to the same option in Checker. The method will be completely removed in Checkstyle 8.0. See issue#2883
void	setClassLoader(ClassLoader classLoader) Sets classLoader to load class.
void	setModuleFactory(ModuleFactory moduleFactory) Sets the module factory for creating child modules (Checks).
void	setTabWidth(int tabWidth) Sets tab width.
void	setupChild(Configuration childConf) Called by configure() for every child of this component's Configuration.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

beginProcessing, finishProcessing, fireErrors, getFileExtensions, getMessageCollector, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

TreeWalker

public TreeWalker()

Creates a new TreeWalker instance.

Method Detail

setTabWidth

public void setTabWidth(int tabWidth)

Sets tab width.

Parameters:

tabWidth - the distance between tab stops

setCacheFile

@Deprecated
public void setCacheFile(String fileName)

Deprecated. Use Checker.setCacheFile(java.lang.String) instead. It does not do anything now. We just keep the setter for transition period to the same option in Checker. The method will be completely removed in Checkstyle 8.0. See issue#2883

Sets cache file.

Parameters:

fileName - the cache file

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Sets classLoader to load class.

Parameters:

classLoader - class loader to resolve classes with.

setModuleFactory

public void setModuleFactory(ModuleFactory moduleFactory)

Sets the module factory for creating child modules (Checks).

Parameters:

moduleFactory - the factory

finishLocalSetup

public void finishLocalSetup()

Description copied from class: AutomaticBean

Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

The default implementation does nothing.

Overrides:

finishLocalSetup in class AutomaticBean

setupChild

public void setupChild(Configuration childConf)
                throws CheckstyleException

Description copied from class: AutomaticBean

Called by configure() for every child of this component's Configuration.

The default implementation throws CheckstyleException if childConf is null because it doesn't support children. It must be overridden to validate and support children that are wanted.

Overrides:

setupChild in class AutomaticBean

Parameters:

childConf - a child of this component's Configuration

Throws:

CheckstyleException - if there is a configuration error.

See Also:

Configuration.getChildren()

processFiltered

protected void processFiltered(File file,
                               List<String> lines)
                        throws CheckstyleException

Description copied from class: AbstractFileSetCheck

Called to process a file that matches the specified file extensions.

Specified by:

processFiltered in class AbstractFileSetCheck

Parameters:

file - the file to be processed

lines - an immutable list of the contents of the file.

Throws:

CheckstyleException - if error condition within Checkstyle occurs.

parse

public static DetailAST parse(FileContents contents)
                       throws antlr.RecognitionException,
                              antlr.TokenStreamException

Static helper method to parses a Java source file.

Parameters:

contents - contains the contents of the file

Returns:

the root of the AST

Throws:

antlr.TokenStreamException - if lexing failed

antlr.RecognitionException - if parsing failed

parseWithComments

public static DetailAST parseWithComments(FileContents contents)
                                   throws antlr.RecognitionException,
                                          antlr.TokenStreamException

Parses Java source file. Result AST contains comment nodes.

Parameters:

contents - source file content

Returns:

DetailAST tree

Throws:

antlr.RecognitionException - if parser failed

antlr.TokenStreamException - if lexer failed

destroy

public void destroy()

Description copied from interface: FileSetCheck

Cleans up the object.

Specified by:

destroy in interface FileSetCheck

Overrides:

destroy in class AbstractFileSetCheck

getExternalResourceLocations

public Set<String> getExternalResourceLocations()

Description copied from interface: ExternalResourceHolder

Returns a set of external configuration resource locations which are used by the module. ATTENTION! If 'getExternalResourceLocations()' return null, there will be NullPointerException in Checker. Such behaviour will signal that your module (check or filter) is designed incorrectly. It make sense to return an empty set from 'getExternalResourceLocations()' only for composite modules like TreeWalker.

Specified by:

getExternalResourceLocations in interface ExternalResourceHolder

Returns:

a set of external configuration resource locations which are used by the module.