|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.puppycrawl.tools.checkstyle.api.AutomaticBean com.puppycrawl.tools.checkstyle.XMLLogger
public class XMLLogger
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 filenames are localized and takes care about escaping as well.
Constructor Summary | |
---|---|
XMLLogger(OutputStream aOS,
boolean aCloseStream)
Creates a new XMLLogger instance. |
Method Summary | |
---|---|
void |
addError(AuditEvent aEvt)
Notify that an audit error was discovered on a specific file. |
void |
addException(AuditEvent aEvt,
Throwable aThrowable)
Notify that an exception happened while performing audit. |
void |
auditFinished(AuditEvent aEvt)
Notify that the audit is finished. |
void |
auditStarted(AuditEvent aEvt)
Notify that the audit is about to start. |
String |
encode(String aValue)
Escape <, > & ' and " as their entities. |
void |
fileFinished(AuditEvent aEvt)
Notify that audit is finished on a specific file. |
void |
fileStarted(AuditEvent aEvt)
Notify that audit is about to start on a specific file. |
boolean |
isReference(String aEnt)
|
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
---|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLLogger(OutputStream aOS, boolean aCloseStream)
XMLLogger
instance.
Sets the output to a defined stream.
aOS
- the stream to write logs to.aCloseStream
- close aOS in auditFinishedMethod Detail |
---|
public void auditStarted(AuditEvent aEvt)
auditStarted
in interface AuditListener
aEvt
- the event detailspublic void auditFinished(AuditEvent aEvt)
auditFinished
in interface AuditListener
aEvt
- the event detailspublic void fileStarted(AuditEvent aEvt)
fileStarted
in interface AuditListener
aEvt
- the event detailspublic void fileFinished(AuditEvent aEvt)
fileFinished
in interface AuditListener
aEvt
- the event detailspublic void addError(AuditEvent aEvt)
addError
in interface AuditListener
aEvt
- the event detailspublic void addException(AuditEvent aEvt, Throwable aThrowable)
addException
in interface AuditListener
aEvt
- the event detailsaThrowable
- details of the exceptionpublic String encode(String aValue)
aValue
- the value to escape.
public boolean isReference(String aEnt)
aEnt
- the possible entity to look for.
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |