org.apache.maven.plugin.checkstyle
Class CheckstyleReportListener

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      org.apache.maven.plugin.checkstyle.CheckstyleReportListener

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.AuditListener, com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable, EventListener

public class CheckstyleReportListener
extends com.puppycrawl.tools.checkstyle.api.AutomaticBean
implements com.puppycrawl.tools.checkstyle.api.AuditListener

Listener in charge of receiving events from the Checker.

Version:

$Id: CheckstyleReportListener.html 816663 2012-05-08 14:00:13Z hboutemy $

Author:

Emmanuel Venisse, Vincent Siveton

Constructor Summary

CheckstyleReportListener(File sourceDirectory)

CheckstyleReportListener(File sourceDirectory, com.puppycrawl.tools.checkstyle.api.Configuration configuration)

Method Summary

void	addError(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
void	addException(com.puppycrawl.tools.checkstyle.api.AuditEvent event, Throwable throwable)
void	addSourceDirectory(File sourceDirectory)
void	auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
void	auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
void	fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
void	fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
com.puppycrawl.tools.checkstyle.api.Configuration	getCheckstyleConfiguration()
CheckstyleResults	getResults()
com.puppycrawl.tools.checkstyle.api.SeverityLevel	getSeverityLevelFilter()
void	setCheckstyleConfiguration(com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfiguration)
void	setResults(CheckstyleResults results)
void	setSeverityLevelFilter(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel)

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

CheckstyleReportListener

public CheckstyleReportListener(File sourceDirectory)

Parameters:

sourceDirectory - assume that is sourceDirectory is a not null directory and exists

CheckstyleReportListener

public CheckstyleReportListener(File sourceDirectory,
                                com.puppycrawl.tools.checkstyle.api.Configuration configuration)

Parameters:

sourceDirectory - assume that is sourceDirectory is a not null directory and exists

configuration - checkstyle configuration

Since:

2.5

Method Detail

addSourceDirectory

public void addSourceDirectory(File sourceDirectory)

Parameters:

sourceDirectory - assume that is sourceDirectory is a not null directory and exists

setSeverityLevelFilter

public void setSeverityLevelFilter(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel)

Parameters:

severityLevel -

getSeverityLevelFilter

public com.puppycrawl.tools.checkstyle.api.SeverityLevel getSeverityLevelFilter()

Returns:

auditStarted

public void auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent event)

Specified by:

auditStarted in interface com.puppycrawl.tools.checkstyle.api.AuditListener

auditFinished

public void auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)

Specified by:

auditFinished in interface com.puppycrawl.tools.checkstyle.api.AuditListener

fileStarted

public void fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent event)

Specified by:

fileStarted in interface com.puppycrawl.tools.checkstyle.api.AuditListener

fileFinished

public void fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)

Specified by:

fileFinished in interface com.puppycrawl.tools.checkstyle.api.AuditListener

addError

public void addError(com.puppycrawl.tools.checkstyle.api.AuditEvent event)

Specified by:

addError in interface com.puppycrawl.tools.checkstyle.api.AuditListener

addException

public void addException(com.puppycrawl.tools.checkstyle.api.AuditEvent event,
                         Throwable throwable)

Specified by:

addException in interface com.puppycrawl.tools.checkstyle.api.AuditListener

getResults

public CheckstyleResults getResults()

Returns:

setResults

public void setResults(CheckstyleResults results)

Parameters:

results -

getCheckstyleConfiguration

public com.puppycrawl.tools.checkstyle.api.Configuration getCheckstyleConfiguration()

Since:

2.5

setCheckstyleConfiguration

public void setCheckstyleConfiguration(com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfiguration)

Since:

2.5