org.apache.maven.plugins.checkstyle.exec

Class CheckstyleCheckerListener

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener

All Implemented Interfaces:

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

public class CheckstyleCheckerListener
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$

Field Summary

Fields

Modifier and Type	Field and Description
private com.puppycrawl.tools.checkstyle.api.Configuration	checkstyleConfiguration
private java.lang.String	currentFile
private java.util.List<com.puppycrawl.tools.checkstyle.api.AuditEvent>	events
private CheckstyleResults	results
private com.puppycrawl.tools.checkstyle.api.SeverityLevel	severityLevel
private java.util.List<java.io.File>	sourceDirectories

Constructor Summary

Constructors

Constructor and Description
CheckstyleCheckerListener(com.puppycrawl.tools.checkstyle.api.Configuration configuration)
CheckstyleCheckerListener(java.io.File sourceDirectory)
CheckstyleCheckerListener(java.io.File sourceDirectory, com.puppycrawl.tools.checkstyle.api.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	addError(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
void	addException(com.puppycrawl.tools.checkstyle.api.AuditEvent event, java.lang.Throwable throwable)
void	addSourceDirectory(java.io.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

Field Detail

sourceDirectories

private java.util.List<java.io.File> sourceDirectories

results

private CheckstyleResults results

currentFile

private java.lang.String currentFile

events

private java.util.List<com.puppycrawl.tools.checkstyle.api.AuditEvent> events

severityLevel

private com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel

checkstyleConfiguration

private com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfiguration

Constructor Detail

CheckstyleCheckerListener

public CheckstyleCheckerListener(java.io.File sourceDirectory)

Parameters:

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

CheckstyleCheckerListener

public CheckstyleCheckerListener(java.io.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

CheckstyleCheckerListener

public CheckstyleCheckerListener(com.puppycrawl.tools.checkstyle.api.Configuration configuration)

Parameters:

configuration - Checkstyle configuration

Since:

2.5

Method Detail

addSourceDirectory

public void addSourceDirectory(java.io.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 - The severity level of the events to listen to.

getSeverityLevelFilter

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

Returns:

The severity level of the events to listen to.

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,
                         java.lang.Throwable throwable)

Specified by:

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

getResults

public CheckstyleResults getResults()

Returns:

The results of Checkstyle invocation.

setResults

public void setResults(CheckstyleResults results)

Parameters:

results - The results of Checkstyle invocation.

getCheckstyleConfiguration

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

Returns:

The configuration of Checkstyle to use.

Since:

2.5

setCheckstyleConfiguration

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

Parameters:

checkstyleConfiguration - The configuration of Checkstyle to use.

Since:

2.5