|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface FileSetCheck
Interface for Checking a set of files for some criteria.
| Method Summary | |
|---|---|
void |
beginProcessing(String aCharset)
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. |
void |
init()
Initialise the instance. |
TreeSet<LocalizedMessage> |
process(File aFile,
List<String> aLines)
Request to process a file. |
void |
setMessageDispatcher(MessageDispatcher aDispatcher)
Sets the MessageDispatcher that is used to dispatch error messages to AuditListeners during processing. |
| Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable |
|---|
configure |
| Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable |
|---|
contextualize |
| Method Detail |
|---|
void setMessageDispatcher(MessageDispatcher aDispatcher)
aDispatcher - the dispatchervoid init()
void destroy()
void beginProcessing(String aCharset)
aCharset - the character set used to read the files.
TreeSet<LocalizedMessage> process(File aFile,
List<String> aLines)
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.
aFile - the file to be processedaLines - an immutable list of the contents of the file.
void finishProcessing()
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||