com.puppycrawl.tools.checkstyle.api

Class AbstractFileSetCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck

Direct Known Subclasses:

AbstractHeaderCheck, FileLengthCheck, FileTabCharacterCheck, JavadocPackageCheck, NewlineAtEndOfFileCheck, RegexpMultilineCheck, RegexpSinglelineCheck, TranslationCheck, TreeWalker, UniquePropertiesCheck

public abstract class AbstractFileSetCheck
extends AbstractViolationReporter
implements FileSetCheck

Provides common functionality for many FileSetChecks.

Author:

lkuehne, oliver

Constructor Summary

Constructors

Constructor and Description
AbstractFileSetCheck()

Method Summary

Modifier and Type	Method and Description
void	beginProcessing(String charset) Called when about to be called to process a set of files.
void	destroy() Cleans up the object.
void	finishProcessing() Called when all the files have been processed.
protected void	fireErrors(String fileName) Notify all listeners about the errors in a file.
String[]	getFileExtensions()
protected LocalizedMessages	getMessageCollector() Returns the collector for violation messages.
protected MessageDispatcher	getMessageDispatcher() A message dispatcher is used to fire violation messages to interested audit listeners.
void	init() Initialise the instance.
void	log(int lineNo, int colNo, String key, Object... args) Log a message that has column information.
void	log(int line, String key, Object... args) Log a message that has no column information.
SortedSet<LocalizedMessage>	process(File file, List<String> lines) Request to process a file.
protected abstract void	processFiltered(File file, List<String> lines) Called to process a file that matches the specified file extensions.
void	setFileExtensions(String... extensions) Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
void	setMessageDispatcher(MessageDispatcher messageDispatcher) Sets the MessageDispatcher that is used to dispatch error messages to AuditListeners during processing.

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, finishLocalSetup, getConfiguration, setupChild

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

AbstractFileSetCheck

public AbstractFileSetCheck()

Method Detail

processFiltered

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

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

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.

init

public void init()

Description copied from interface: FileSetCheck

Initialise the instance. This is the time to verify that everything required to perform it job.

Specified by:

init in interface FileSetCheck

destroy

public void destroy()

Description copied from interface: FileSetCheck

Cleans up the object.

Specified by:

destroy in interface FileSetCheck

beginProcessing

public void beginProcessing(String charset)

Description copied from interface: FileSetCheck

Called when about to be called to process a set of files.

Specified by:

beginProcessing in interface FileSetCheck

Parameters:

charset - the character set used to read the files.

process

public final SortedSet<LocalizedMessage> process(File file,
                                                 List<String> lines)
                                          throws CheckstyleException

Description copied from interface: FileSetCheck

Request to process a file. The implementation should use the supplied contents and not read the contents again. This reduces the amount of file I/O.

The file set to process might contain files that are not interesting to the FileSetCheck. Such files should be ignored, no error message should be fired for them. For example a FileSetCheck that checks java files should ignore HTML or properties files.

The method should return the set of messages to be logged.

Specified by:

process in interface FileSetCheck

Parameters:

file - the file to be processed

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

Returns:

the sorted set of messages to be logged.

Throws:

CheckstyleException - if error condition within Checkstyle occurs

finishProcessing

public void finishProcessing()

Description copied from interface: FileSetCheck

Called when all the files have been processed. This is the time to perform any checks that need to be done across a set of files. In this method, the implementation is responsible for the logging of messages.

Specified by:

finishProcessing in interface FileSetCheck

setMessageDispatcher

public final void setMessageDispatcher(MessageDispatcher messageDispatcher)

Description copied from interface: FileSetCheck

Sets the MessageDispatcher that is used to dispatch error messages to AuditListeners during processing.

Specified by:

setMessageDispatcher in interface FileSetCheck

Parameters:

messageDispatcher - the dispatcher

getMessageDispatcher

protected final MessageDispatcher getMessageDispatcher()

A message dispatcher is used to fire violation messages to interested audit listeners.

Returns:

the current MessageDispatcher.

getFileExtensions

public String[] getFileExtensions()

Returns:

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

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.

Throws:

IllegalArgumentException - is argument is null

getMessageCollector

protected final LocalizedMessages getMessageCollector()

Returns the collector for violation messages. Subclasses can use the collector to find out the violation messages to fire via the message dispatcher.

Returns:

the collector for localized messages.

log

public final void log(int line,
                      String key,
                      Object... args)

Description copied from class: AbstractViolationReporter

Log a message that has no column information.

Specified by:

log in class AbstractViolationReporter

Parameters:

line - the line number where the error was found

key - the message that describes the error

args - the details of the message

See Also:

MessageFormat

log

public final void log(int lineNo,
                      int colNo,
                      String key,
                      Object... args)

Description copied from class: AbstractViolationReporter

Log a message that has column information.

Specified by:

log in class AbstractViolationReporter

Parameters:

lineNo - the line number where the error was found

colNo - the column number where the error was found

key - the message that describes the error

args - the details of the message

See Also:

MessageFormat

fireErrors

protected final void fireErrors(String fileName)

Notify all listeners about the errors in a file. Calls MessageDispatcher.fireErrors() with all logged errors and than clears errors' list.

Parameters:

fileName - the audited file