Package com.puppycrawl.tools.checkstyle

Class XpathFileGeneratorAuditListener

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener

All Implemented Interfaces:

AuditListener, Configurable, Contextualizable, java.util.EventListener

public class XpathFileGeneratorAuditListener
extends AutomaticBean
implements AuditListener

Generates suppressions.xml file, based on violations occurred. See issue #102 https://github.com/checkstyle/checkstyle/issues/102

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closeStream	Close output stream in auditFinished.
private boolean	isXmlHeaderPrinted	Determines if xml header is printed.
private static java.lang.String	QUOTE_CHAR	The " quote character.
private java.io.PrintWriter	writer	Helper writer that allows easy encoding and printing.

Constructor Summary

Constructors

Constructor	Description
XpathFileGeneratorAuditListener(java.io.OutputStream out, AutomaticBean.OutputStreamOptions outputStreamOptions)	Creates a new SuppressionFileGenerator instance.

Method Summary

Modifier and Type	Method	Description
void	addError(AuditEvent event)	Notify that an audit error was discovered on a specific file.
void	addException(AuditEvent event, java.lang.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.
protected void	finishLocalSetup()	Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
private void	printXmlHeader()	Prints XML header if only it was not printed before.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

QUOTE_CHAR

private static final java.lang.String QUOTE_CHAR

The " quote character.

See Also:

Constant Field Values

writer

private final java.io.PrintWriter writer

Helper writer that allows easy encoding and printing.

closeStream

private final boolean closeStream

Close output stream in auditFinished.

isXmlHeaderPrinted

private boolean isXmlHeaderPrinted

Determines if xml header is printed.

Constructor Detail

XpathFileGeneratorAuditListener

public XpathFileGeneratorAuditListener(java.io.OutputStream out,
                                       AutomaticBean.OutputStreamOptions outputStreamOptions)

Creates a new SuppressionFileGenerator instance. Sets the output to a defined stream.

Parameters:

out - the output stream

outputStreamOptions - if CLOSE stream should be closed in auditFinished()

Method Detail

auditStarted

public void auditStarted(AuditEvent event)

Description copied from interface: AuditListener

Notify that the audit is about to start.

Specified by:

auditStarted in interface AuditListener

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 interface AuditListener

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 interface AuditListener

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 interface AuditListener

Parameters:

event - the event details

addError

public void addError(AuditEvent event)

Description copied from interface: AuditListener

Notify that an audit error was discovered on a specific file.

Specified by:

addError in interface AuditListener

Parameters:

event - the event details

addException

public void addException(AuditEvent event,
                         java.lang.Throwable throwable)

Description copied from interface: AuditListener

Notify that an exception happened while performing audit.

Specified by:

addException in interface AuditListener

Parameters:

event - the event details

throwable - details of the exception

printXmlHeader

private void printXmlHeader()

Prints XML header if only it was not printed before.

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 class AutomaticBean