|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.puppycrawl.tools.checkstyle.XMLLogger
Simple XML logger. It outputs everything in UTF8 (default XML encoding is UTF8) in case we want to localize error messages or simply that filenames are localized and takes care about escaping as well.
Constructor Summary | |
XMLLogger(java.io.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,
java.lang.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 |
java.lang.String |
encode(java.lang.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(java.lang.String aEnt)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XMLLogger(java.io.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)
AuditListener
auditStarted
in interface AuditListener
aEvt
- the event detailsAuditListener
public void auditFinished(AuditEvent aEvt)
AuditListener
auditFinished
in interface AuditListener
aEvt
- the event detailsAuditListener
public void fileStarted(AuditEvent aEvt)
AuditListener
fileStarted
in interface AuditListener
aEvt
- the event detailsAuditListener
public void fileFinished(AuditEvent aEvt)
AuditListener
fileFinished
in interface AuditListener
aEvt
- the event detailsAuditListener
public void addError(AuditEvent aEvt)
AuditListener
addError
in interface AuditListener
aEvt
- the event detailsAuditListener
public void addException(AuditEvent aEvt, java.lang.Throwable aThrowable)
AuditListener
addException
in interface AuditListener
aEvt
- the event detailsaThrowable
- details of the exceptionAuditListener
public java.lang.String encode(java.lang.String aValue)
aValue
- the value to escape.
public boolean isReference(java.lang.String aEnt)
aEnt
- the possible entity to look for.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |