public abstract class AbstractFileSetCheck extends AbstractViolationReporter implements FileSetCheck
Constructor and Description |
---|
AbstractFileSetCheck() |
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.
|
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.
|
TreeSet<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 dispatcher)
Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
configure
contextualize
public AbstractFileSetCheck()
protected abstract void processFiltered(File file, List<String> lines)
file
- the file to be processedlines
- an immutable list of the contents of the file.public void init()
init
in interface FileSetCheck
public void destroy()
destroy
in interface FileSetCheck
public void beginProcessing(String charset)
beginProcessing
in interface FileSetCheck
charset
- the character set used to read the files.public final 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.
process
in interface FileSetCheck
file
- the file to be processedlines
- an immutable list of the contents of the file.public void finishProcessing()
finishProcessing
in interface FileSetCheck
public final void setMessageDispatcher(MessageDispatcher dispatcher)
setMessageDispatcher
in interface FileSetCheck
dispatcher
- the dispatcherprotected final MessageDispatcher getMessageDispatcher()
public final void setFileExtensions(String[] extensions)
extensions
- the set of file extensions. A missing
initial '.' character of an extension is automatically added.protected final LocalizedMessages getMessageCollector()
public final void log(int line, String key, Object... args)
AbstractViolationReporter
log
in class AbstractViolationReporter
line
- the line number where the error was foundkey
- the message that describes the errorargs
- the details of the messageMessageFormat
public final void log(int lineNo, int colNo, String key, Object... args)
AbstractViolationReporter
log
in class AbstractViolationReporter
lineNo
- the line number where the error was foundcolNo
- the column number where the error was foundkey
- the message that describes the errorargs
- the details of the messageMessageFormat
protected final void fireErrors(String fileName)
MessageDispatcher.fireErrors()
with
all logged errors and than clears errors' list.fileName
- the audited fileCopyright © 2001–2015. All rights reserved.