com.puppycrawl.tools.checkstyle.api
Interface FileSetCheck
- Configurable, Contextualizable
- AbstractFileSetCheck, TreeWalker
public interface FileSetCheck
Interface for Checking a set of files for some criteria.
void | destroy() - Cleans up the object.
|
void | process(File[] aFiles) - Processes a set of files and fires errors to the MessageDispatcher.
|
void | setMessageDispatcher(MessageDispatcher aDispatcher) - Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
|
destroy
public void destroy()
Cleans up the object. *
process
public void process(File[] aFiles)
Processes a set of files and fires errors to the MessageDispatcher.
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.
Once processiong is done, it is highly recommended to call for
the destroy method to close and remove the listeners.
aFiles
- the files to be audited.
setMessageDispatcher
public void setMessageDispatcher(MessageDispatcher aDispatcher)
Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
aDispatcher
- the dispatcher