Package com.puppycrawl.tools.checkstyle
Class DefaultLogger
java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.DefaultLogger
- All Implemented Interfaces:
AuditListener
,Configurable
,Contextualizable
,EventListener
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.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
A key pointing to the add exception message in the "messages.properties" file.static final String
A key pointing to the finished audit message in the "messages.properties" file.static final String
A key pointing to the started audit message in the "messages.properties" file.private final boolean
Close error stream after use.private final boolean
Close info stream after use.private final PrintWriter
Where to write error messages.private final AuditEventFormatter
Formatter for the log message.private final PrintWriter
Where to write info messages. -
Constructor Summary
ConstructorDescriptionDefaultLogger
(OutputStream outputStream, AbstractAutomaticBean.OutputStreamOptions outputStreamOptions) Creates a newDefaultLogger
instance.DefaultLogger
(OutputStream infoStream, AbstractAutomaticBean.OutputStreamOptions infoStreamOptions, OutputStream errorStream, AbstractAutomaticBean.OutputStreamOptions errorStreamOptions) Creates a newDefaultLogger
instance.DefaultLogger
(OutputStream infoStream, AbstractAutomaticBean.OutputStreamOptions infoStreamOptions, OutputStream errorStream, AbstractAutomaticBean.OutputStreamOptions errorStreamOptions, AuditEventFormatter messageFormatter) Creates a newDefaultLogger
instance.DefaultLogger
(OutputStream outputStream, AutomaticBean.OutputStreamOptions outputStreamOptions) Creates a newDefaultLogger
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.private void
Flushes the output streams and closes them if needed.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.protected void
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
ADD_EXCEPTION_MESSAGE
A key pointing to the add exception message in the "messages.properties" file.- See Also:
-
AUDIT_STARTED_MESSAGE
A key pointing to the started audit message in the "messages.properties" file.- See Also:
-
AUDIT_FINISHED_MESSAGE
A key pointing to the finished audit message in the "messages.properties" file.- See Also:
-
infoWriter
Where to write info messages. -
closeInfo
Close info stream after use. -
errorWriter
Where to write error messages. -
closeError
Close error stream after use. -
formatter
Formatter for the log message.
-
-
Constructor Details
-
DefaultLogger
public DefaultLogger(OutputStream outputStream, AutomaticBean.OutputStreamOptions outputStreamOptions) Creates a newDefaultLogger
instance.- Parameters:
outputStream
- where to log audit eventsoutputStreamOptions
- ifCLOSE
that should be closed in auditFinished()
-
DefaultLogger
public DefaultLogger(OutputStream outputStream, AbstractAutomaticBean.OutputStreamOptions outputStreamOptions) Creates a newDefaultLogger
instance.- Parameters:
outputStream
- where to log audit eventsoutputStreamOptions
- ifCLOSE
that should be closed in auditFinished()
-
DefaultLogger
public DefaultLogger(OutputStream infoStream, AbstractAutomaticBean.OutputStreamOptions infoStreamOptions, OutputStream errorStream, AbstractAutomaticBean.OutputStreamOptions errorStreamOptions) Creates a newDefaultLogger
instance.- Parameters:
infoStream
- theOutputStream
for info messages.infoStreamOptions
- ifCLOSE
info should be closed in auditFinished()errorStream
- theOutputStream
for error messages.errorStreamOptions
- ifCLOSE
error should be closed in auditFinished()
-
DefaultLogger
public DefaultLogger(OutputStream infoStream, AbstractAutomaticBean.OutputStreamOptions infoStreamOptions, OutputStream errorStream, AbstractAutomaticBean.OutputStreamOptions errorStreamOptions, AuditEventFormatter messageFormatter) Creates a newDefaultLogger
instance.- Parameters:
infoStream
- theOutputStream
for info messagesinfoStreamOptions
- ifCLOSE
info should be closed in auditFinished()errorStream
- theOutputStream
for error messageserrorStreamOptions
- ifCLOSE
error should be closed in auditFinished()messageFormatter
- formatter for the log message.- Throws:
IllegalArgumentException
- if stream options are null
-
-
Method Details
-
finishLocalSetup
Description copied from class:AbstractAutomaticBean
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.The default implementation does nothing.
- Specified by:
finishLocalSetup
in classAbstractAutomaticBean
-
addError
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:
-
addException
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
Description copied from interface:AuditListener
Notify that the audit is about to start.- Specified by:
auditStarted
in interfaceAuditListener
- Parameters:
event
- the event details
-
auditFinished
Description copied from interface:AuditListener
Notify that the audit is finished.- Specified by:
auditFinished
in interfaceAuditListener
- Parameters:
event
- the event details
-
fileStarted
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
Description copied from interface:AuditListener
Notify that audit is finished on a specific file.- Specified by:
fileFinished
in interfaceAuditListener
- Parameters:
event
- the event details
-
closeStreams
Flushes the output streams and closes them if needed.
-