public interface FileSetCheck extends Configurable, Contextualizable
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.
|
void |
init()
Initialise the instance.
|
TreeSet<LocalizedMessage> |
process(File file,
List<String> lines)
Request to process a file.
|
void |
setMessageDispatcher(MessageDispatcher dispatcher)
Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
|
configure
contextualize
void setMessageDispatcher(MessageDispatcher dispatcher)
dispatcher
- the dispatchervoid init()
void destroy()
void beginProcessing(String charset)
charset
- the character set used to read the files.TreeSet<LocalizedMessage> process(File file, List<String> lines)
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.
file
- the file to be processedlines
- an immutable list of the contents of the file.void finishProcessing()
Copyright © 2001–2015. All rights reserved.