org.opendaylight.yangtools.checkstyle

Class LogMessageExtractorCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

org.opendaylight.yangtools.checkstyle.AbstractLogMessageCheck

org.opendaylight.yangtools.checkstyle.LogMessageExtractorCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class LogMessageExtractorCheck
extends AbstractLogMessageCheck

Check which extracts the content of Logger messages somewhere (e.g. a file).

This can be used to create a comprehensive list of all log messages.

It is a first step towards more formal tracking of all messages from a system with a unique ID, using e.g. a framework such as jboss-logging.

Does not actually Check anything, i.e. never emits any Checkstyle warnings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogMessageExtractorCheck.LogMessageOccurence

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
LogMessageExtractorCheck()

Method Summary

Modifier and Type	Method and Description
File	getLogMessagesReportFile()
void	setLogMessagesReportFileName(String fileName)
protected void	updateMessagesReportFile(LogMessageExtractorCheck.LogMessageOccurence log)
protected void	visitLogMessage(com.puppycrawl.tools.checkstyle.api.DetailAST ast, String logMessage)

Methods inherited from class org.opendaylight.yangtools.checkstyle.AbstractLogMessageCheck

getAcceptableTokens, getDefaultTokens, getRequiredTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogMessageExtractorCheck

public LogMessageExtractorCheck()

Method Detail

setLogMessagesReportFileName

public void setLogMessagesReportFileName(String fileName)

getLogMessagesReportFile

public File getLogMessagesReportFile()

visitLogMessage

protected void visitLogMessage(com.puppycrawl.tools.checkstyle.api.DetailAST ast,
                               String logMessage)

Specified by:

visitLogMessage in class AbstractLogMessageCheck

updateMessagesReportFile

protected void updateMessagesReportFile(LogMessageExtractorCheck.LogMessageOccurence log)