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

public class Checker

extends AutomaticBean

implements MessageDispatcher

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

Author:

Oliver Burn, Stephane Bailliez, lkuehne

Constructor Summary

Checker()
Creates a new Checker instance.

Method Summary

void	addFileSetCheck(FileSetCheck aFileSetCheck) Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
void	addFilter(Filter aFilter) Adds a filter to the end of the audit event filter chain.
void	addListener(AuditListener aListener) Add the listener that will be used to receive events from the audit.
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.
protected void	fireAuditFinished() notify all listeners about the audit end
protected void	fireAuditStarted() notify all listeners about the audit start
void	fireErrors(java.lang.String aFileName, LocalizedMessage[] aErrors) notify all listeners about the errors in a file.
void	fireFileFinished(java.lang.String aFileName) Notify all listeners about the end of a file audit.
void	fireFileStarted(java.lang.String aFileName) Notify all listeners about the beginning of a file audit.
java.lang.String	normalize(java.lang.String aPath) "normalize" the given absolute path.
int	process(java.io.File[] aFiles) Processes a set of files with all FileSetChecks.
void	removeFilter(Filter aFilter) Removes filter.
void	removeListener(AuditListener aListener) Removes a given listener.
void	setBasedir(java.lang.String aBasedir)
void	setClassloader(java.lang.ClassLoader aLoader) Sets the classloader that is used to contextualize filesetchecks.
void	setLocaleCountry(java.lang.String aLocaleCountry)
void	setLocaleLanguage(java.lang.String aLocaleLanguage)
void	setModuleFactory(ModuleFactory aModuleFactory) Sets the factory for creating submodules.
void	setSeverity(java.lang.String aSeverity) Sets the severity level.
protected void	setupChild(Configuration aChildConf) Instantiates, configures and registers a child AbstractFilter or FileSetCheck that is specified in the provided 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

Constructor Detail

Checker

public Checker()
        throws CheckstyleException

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

Throws:

CheckstyleException - if an error occurs

Method Detail

finishLocalSetup

public void finishLocalSetup()
                      throws CheckstyleException

Description copied from class: AutomaticBean

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

The default implementation does nothing.

Overrides:

finishLocalSetup in class AutomaticBean

Throws:

CheckstyleException - if there is a configuration error.

See Also:

AutomaticBean

setupChild

protected void setupChild(Configuration aChildConf)
                   throws CheckstyleException

Instantiates, configures and registers a child AbstractFilter or FileSetCheck that is specified in the provided configuration.

Overrides:

setupChild in class AutomaticBean

Parameters:

aChildConf - a child of this component's Configuration

Throws:

CheckstyleException - if there is a configuration error.

See Also:

AutomaticBean

addFileSetCheck

public void addFileSetCheck(FileSetCheck aFileSetCheck)

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

Parameters:

aFileSetCheck - the additional FileSetCheck

addFilter

public void addFilter(Filter aFilter)

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

Parameters:

aFilter - the additional filter

removeFilter

public void removeFilter(Filter aFilter)

Removes filter.

Parameters:

aFilter - filter to remove.

destroy

public void destroy()

Cleans up the object.

addListener

public void addListener(AuditListener aListener)

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

Parameters:

aListener - the nosy thing

removeListener

public void removeListener(AuditListener aListener)

Removes a given listener.

Parameters:

aListener - a listener to remove

process

public int process(java.io.File[] aFiles)

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

Parameters:

aFiles - the list of files to be audited.

Returns:

the total number of errors found

See Also:

destroy()

setBasedir

public void setBasedir(java.lang.String aBasedir)

Parameters:

aBasedir - the base directory to strip off in filenames

normalize

public java.lang.String normalize(java.lang.String aPath)

"normalize" the given absolute path.

This includes:

• Uppercase the drive letter if there is one.
• Remove redundant slashes after the drive spec.
• resolve all ./, .\, ../ and ..\ sequences.
• DOS style paths that start with a drive letter will have \ as the separator.

Parameters:

aPath - a path for "normalizing"

Returns:

"normalized" file name

Throws:

java.lang.NullPointerException - if the file path is equal to null.

fireAuditStarted

protected void fireAuditStarted()

notify all listeners about the audit start

fireAuditFinished

protected void fireAuditFinished()

notify all listeners about the audit end

fireFileStarted

public void fireFileStarted(java.lang.String aFileName)

Notify all listeners about the beginning of a file audit.

Specified by:

fireFileStarted in interface MessageDispatcher

Parameters:

aFileName - the file to be audited

fireFileFinished

public void fireFileFinished(java.lang.String aFileName)

Notify all listeners about the end of a file audit.

Specified by:

fireFileFinished in interface MessageDispatcher

Parameters:

aFileName - the audited file

fireErrors

public void fireErrors(java.lang.String aFileName,
                       LocalizedMessage[] aErrors)

notify all listeners about the errors in a file.

Specified by:

fireErrors in interface MessageDispatcher

Parameters:

aFileName - the audited file

aErrors - the audit errors from the file

setModuleFactory

public void setModuleFactory(ModuleFactory aModuleFactory)

Sets the factory for creating submodules.

Parameters:

aModuleFactory - the factory for creating FileSetChecks

setLocaleCountry

public void setLocaleCountry(java.lang.String aLocaleCountry)

Parameters:

aLocaleCountry - the country to report messages

setLocaleLanguage

public void setLocaleLanguage(java.lang.String aLocaleLanguage)

Parameters:

aLocaleLanguage - the language to report messages

setSeverity

public final void setSeverity(java.lang.String aSeverity)

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

Parameters:

aSeverity - The new severity level

See Also:

SeverityLevel

setClassloader

public final void setClassloader(java.lang.ClassLoader aLoader)

Sets the classloader that is used to contextualize filesetchecks. 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:

aLoader - the new classloader