com.puppycrawl.tools.checkstyle

Class Checker

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.Checker

All Implemented Interfaces:

Configurable, Contextualizable, MessageDispatcher, RootModule

public class Checker
extends AutomaticBean
implements MessageDispatcher, RootModule

This class provides the functionality to check a set of files.

Author:

Oliver Burn, Stephane Bailliez, lkuehne, Andrei Selkin

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION_MSG Message to use when an exception occurs and should be printed as a violation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addBeforeExecutionFileFilter(BeforeExecutionFileFilter filter) Adds a before execution file filter to the end of the event chain.
void	addFileSetCheck(FileSetCheck fileSetCheck) Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
void	addFilter(Filter filter) Adds a filter to the end of the audit event filter chain.
void	addListener(AuditListener listener) Add the listener that will be used to receive events from the audit.
void	clearCache() Clears the cache.
void	destroy() Cleans up the object.
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
void	fireErrors(String fileName, SortedSet<LocalizedMessage> errors) Notify all listeners about the errors in a file.
void	fireFileFinished(String fileName) Notify all listeners about the end of a file audit.
void	fireFileStarted(String fileName) Notify all listeners about the beginning of a file audit.
int	process(List<File> files) Processes a set of files.
void	removeBeforeExecutionFileFilter(BeforeExecutionFileFilter filter) Removes before execution file filter.
void	removeFilter(Filter filter) Removes filter.
void	removeListener(AuditListener listener) Removes a given listener.
void	setBasedir(String basedir) Sets base directory.
void	setCacheFile(String fileName) Sets cache file.
void	setCharset(String charset) Sets a named charset.
void	setClassLoader(ClassLoader classLoader) Sets the classloader that is used to contextualize fileset checks.
void	setFileExtensions(String... extensions) Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
void	setHaltOnException(boolean haltOnException) Sets the field haltOnException.
void	setLocaleCountry(String localeCountry) Sets locale country.
void	setLocaleLanguage(String localeLanguage) Sets locale language.
void	setModuleClassLoader(ClassLoader moduleClassLoader) Sets the classloader used to load Checkstyle core and custom module classes when the module tree is being built up.
void	setModuleFactory(ModuleFactory moduleFactory) Sets the factory for creating submodules.
void	setSeverity(String severity) Sets the severity level.
protected void	setupChild(Configuration childConf) Called by configure() for every child of this component's Configuration.

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

Field Detail

EXCEPTION_MSG

public static final String EXCEPTION_MSG

Message to use when an exception occurs and should be printed as a violation.

See Also:

Constant Field Values

Constructor Detail

Checker

public Checker()

Creates a new Checker instance. The instance needs to be contextualized and configured.

Method Detail

setCacheFile

public void setCacheFile(String fileName)
                  throws IOException

Sets cache file.

Parameters:

fileName - the cache file.

Throws:

IOException - if there are some problems with file loading.

removeBeforeExecutionFileFilter

public void removeBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)

Removes before execution file filter.

Parameters:

filter - before execution file filter to remove.

removeFilter

public void removeFilter(Filter filter)

Removes filter.

Parameters:

filter - filter to remove.

destroy

public void destroy()

Description copied from interface: RootModule

Cleans up the object.

Specified by:

destroy in interface RootModule

removeListener

public void removeListener(AuditListener listener)

Removes a given listener.

Parameters:

listener - a listener to remove

setBasedir

public void setBasedir(String basedir)

Sets base directory.

Parameters:

basedir - the base directory to strip off in file names

process

public int process(List<File> files)
            throws CheckstyleException

Description copied from interface: RootModule

Processes a set of files. Once this is done, it is highly recommended to call for the destroy method to close and remove the listeners.

Specified by:

process in interface RootModule

Parameters:

files - the list of files to be audited.

Returns:

the total number of errors found

Throws:

CheckstyleException - if error condition within Checkstyle occurs

See Also:

RootModule.destroy()

fireFileStarted

public void fireFileStarted(String fileName)

Notify all listeners about the beginning of a file audit.

Specified by:

fireFileStarted in interface MessageDispatcher

Parameters:

fileName - the file to be audited

fireErrors

public void fireErrors(String fileName,
                       SortedSet<LocalizedMessage> errors)

Notify all listeners about the errors in a file.

Specified by:

fireErrors in interface MessageDispatcher

Parameters:

fileName - the audited file

errors - the audit errors from the file

fireFileFinished

public void fireFileFinished(String fileName)

Notify all listeners about the end of a file audit.

Specified by:

fireFileFinished in interface MessageDispatcher

Parameters:

fileName - the audited file

finishLocalSetup

protected void finishLocalSetup()
                         throws CheckstyleException

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.

Specified by:

finishLocalSetup in class AutomaticBean

Throws:

CheckstyleException - if there is a configuration error.

setupChild

protected void setupChild(Configuration childConf)
                   throws CheckstyleException

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.

Creates child module.

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()

addFileSetCheck

public void addFileSetCheck(FileSetCheck fileSetCheck)

Adds a FileSetCheck to the list of FileSetChecks that is executed in process().

Parameters:

fileSetCheck - the additional FileSetCheck

addBeforeExecutionFileFilter

public void addBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)

Adds a before execution file filter to the end of the event chain.

Parameters:

filter - the additional filter

addFilter

public void addFilter(Filter filter)

Adds a filter to the end of the audit event filter chain.

Parameters:

filter - the additional filter

addListener

public final void addListener(AuditListener listener)

Description copied from interface: RootModule

Add the listener that will be used to receive events from the audit.

Specified by:

addListener in interface RootModule

Parameters:

listener - the nosy thing

setFileExtensions

public final void setFileExtensions(String... extensions)

Sets the file extensions that identify the files that pass the filter of this FileSetCheck.

Parameters:

extensions - the set of file extensions. A missing initial '.' character of an extension is automatically added.

setModuleFactory

public void setModuleFactory(ModuleFactory moduleFactory)

Sets the factory for creating submodules.

Parameters:

moduleFactory - the factory for creating FileSetChecks

setLocaleCountry

public void setLocaleCountry(String localeCountry)

Sets locale country.

Parameters:

localeCountry - the country to report messages

setLocaleLanguage

public void setLocaleLanguage(String localeLanguage)

Sets locale language.

Parameters:

localeLanguage - the language to report messages

setSeverity

public final void setSeverity(String severity)

Sets the severity level. The string should be one of the names defined in the SeverityLevel class.

Parameters:

severity - The new severity level

See Also:

SeverityLevel

setClassLoader

public final void setClassLoader(ClassLoader classLoader)

Sets the classloader that is used to contextualize fileset checks. Some Check implementations will use that classloader to improve the quality of their reports, e.g. to load a class and then analyze it via reflection.

Parameters:

classLoader - the new classloader

setModuleClassLoader

public final void setModuleClassLoader(ClassLoader moduleClassLoader)

Description copied from interface: RootModule

Sets the classloader used to load Checkstyle core and custom module classes when the module tree is being built up. If no custom ModuleFactory is being set for the root module then this module classloader must be specified.

Specified by:

setModuleClassLoader in interface RootModule

Parameters:

moduleClassLoader - the classloader used to load module classes

setCharset

public void setCharset(String charset)
                throws UnsupportedEncodingException

Sets a named charset.

Parameters:

charset - the name of a charset

Throws:

UnsupportedEncodingException - if charset is unsupported.

setHaltOnException

public void setHaltOnException(boolean haltOnException)

Sets the field haltOnException.

Parameters:

haltOnException - the new value.

clearCache

public void clearCache()

Clears the cache.