Package com.puppycrawl.tools.checkstyle
Class XMLLogger
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.XMLLogger
- All Implemented Interfaces:
AuditListener
,Configurable
,Contextualizable
,EventListener
Simple XML logger.
It outputs everything in UTF-8 (default XML encoding is UTF-8) in case
we want to localize error messages or simply that file names are
localized and takes care about escaping as well.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Constructor Summary
ConstructorsConstructorDescriptionXMLLogger
(OutputStream outputStream, AutomaticBean.OutputStreamOptions outputStreamOptions) Creates a newXMLLogger
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addError
(AuditEvent event) Notify that an audit error was discovered on a specific file.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.static String
Escape <, > & ' and " as their entities.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.static boolean
isReference
(String ent) Finds whether the given argument is character or entity reference.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Constructor Details
-
XMLLogger
Creates a newXMLLogger
instance. Sets the output to a defined stream.- Parameters:
outputStream
- the stream to write logs to.outputStreamOptions
- ifCLOSE
stream should be closed in auditFinished()
-
-
Method Details
-
finishLocalSetup
protected void finishLocalSetup()Description copied from class:AutomaticBean
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 classAutomaticBean
-
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
-
addError
Description copied from interface:AuditListener
Notify that an audit error was discovered on a specific file.- Specified by:
addError
in interfaceAuditListener
- Parameters:
event
- the event details
-
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
-
encode
Escape <, > & ' and " as their entities.- Parameters:
value
- the value to escape.- Returns:
- the escaped value if necessary.
-
isReference
Finds whether the given argument is character or entity reference.- Parameters:
ent
- the possible entity to look for.- Returns:
- whether the given argument a character or entity reference
-