Package com.puppycrawl.tools.checkstyle
Class DefaultLogger
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.DefaultLogger
-
- All Implemented Interfaces:
AuditListener
,Configurable
,Contextualizable
,EventListener
public class DefaultLogger extends AutomaticBean implements AuditListener
Simple plain logger for text output. This is maybe not very suitable for a text output into a file since it does not need all 'audit finished' and so on stuff, but it looks good on stdout anyway. If there is really a problem this is what XMLLogger is for. It gives structure.- Author:
- Stephane Bailliez
- See Also:
XMLLogger
-
-
Field Summary
Fields Modifier and Type Field Description static String
ADD_EXCEPTION_MESSAGE
A key pointing to the add exception message in the "messages.properties" file.static String
AUDIT_FINISHED_MESSAGE
A key pointing to the finished audit message in the "messages.properties" file.static String
AUDIT_STARTED_MESSAGE
A key pointing to the started audit message in the "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description DefaultLogger(OutputStream outputStream, boolean closeStreamsAfterUse)
Creates a newDefaultLogger
instance.DefaultLogger(OutputStream infoStream, boolean closeInfoAfterUse, OutputStream errorStream, boolean closeErrorAfterUse)
Creates a newDefaultLogger
instance.DefaultLogger(OutputStream infoStream, boolean closeInfoAfterUse, OutputStream errorStream, boolean closeErrorAfterUse, AuditEventFormatter messageFormatter)
Creates a newDefaultLogger
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addError(AuditEvent event)
Print an Emacs compliant line on the error stream.void
addException(AuditEvent event, Throwable throwable)
Notify that an exception happened while performing audit.void
auditFinished(AuditEvent event)
Notify that the audit is finished.void
auditStarted(AuditEvent event)
Notify that the audit is about to start.void
fileFinished(AuditEvent event)
Notify that audit is finished on a specific file.void
fileStarted(AuditEvent event)
Notify that audit is about to start on a specific file.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
ADD_EXCEPTION_MESSAGE
public static final String ADD_EXCEPTION_MESSAGE
A key pointing to the add exception message in the "messages.properties" file.- See Also:
- Constant Field Values
-
AUDIT_STARTED_MESSAGE
public static final String AUDIT_STARTED_MESSAGE
A key pointing to the started audit message in the "messages.properties" file.- See Also:
- Constant Field Values
-
AUDIT_FINISHED_MESSAGE
public static final String AUDIT_FINISHED_MESSAGE
A key pointing to the finished audit message in the "messages.properties" file.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DefaultLogger
public DefaultLogger(OutputStream outputStream, boolean closeStreamsAfterUse)
Creates a newDefaultLogger
instance.- Parameters:
outputStream
- where to log infos and errorscloseStreamsAfterUse
- if oS should be closed in auditFinished()
-
DefaultLogger
public DefaultLogger(OutputStream infoStream, boolean closeInfoAfterUse, OutputStream errorStream, boolean closeErrorAfterUse)
Creates a newDefaultLogger
instance.- Parameters:
infoStream
- theOutputStream
for info messages.closeInfoAfterUse
- auditFinished should close infoStream.errorStream
- theOutputStream
for error messages.closeErrorAfterUse
- auditFinished should close errorStream
-
DefaultLogger
public DefaultLogger(OutputStream infoStream, boolean closeInfoAfterUse, OutputStream errorStream, boolean closeErrorAfterUse, AuditEventFormatter messageFormatter)
Creates a newDefaultLogger
instance.- Parameters:
infoStream
- theOutputStream
for info messagescloseInfoAfterUse
- auditFinished should close infoStreamerrorStream
- theOutputStream
for error messagescloseErrorAfterUse
- auditFinished should close errorStreammessageFormatter
- formatter for the log message.
-
-
Method Detail
-
addError
public void addError(AuditEvent event)
Print an Emacs compliant line on the error stream. If the column number is non zero, then also display it.- Specified by:
addError
in interfaceAuditListener
- Parameters:
event
- the event details- See Also:
AuditListener
-
addException
public void addException(AuditEvent event, Throwable throwable)
Description copied from interface:AuditListener
Notify that an exception happened while performing audit.- Specified by:
addException
in interfaceAuditListener
- Parameters:
event
- the event detailsthrowable
- details of the exception
-
auditStarted
public void auditStarted(AuditEvent event)
Description copied from interface:AuditListener
Notify that the audit is about to start.- Specified by:
auditStarted
in interfaceAuditListener
- Parameters:
event
- the event details
-
auditFinished
public void auditFinished(AuditEvent event)
Description copied from interface:AuditListener
Notify that the audit is finished.- Specified by:
auditFinished
in interfaceAuditListener
- Parameters:
event
- the event details
-
fileStarted
public void fileStarted(AuditEvent event)
Description copied from interface:AuditListener
Notify that audit is about to start on a specific file.- Specified by:
fileStarted
in interfaceAuditListener
- Parameters:
event
- the event details
-
fileFinished
public void fileFinished(AuditEvent event)
Description copied from interface:AuditListener
Notify that audit is finished on a specific file.- Specified by:
fileFinished
in interfaceAuditListener
- Parameters:
event
- the event details
-
-