CheckstyleReportListener (Apache Maven Checkstyle Plugin 2.11 API)

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

All Implemented Interfaces:

AuditListener, Configurable, Contextualizable, EventListener
```
public class CheckstyleReportListener
extends AutomaticBean
implements AuditListener
```
Listener in charge of receiving events from the Checker.

Version:

$Id: CheckstyleReportListener.java 1231408 2012-01-13 23:56:46Z rfscholte $

Author:

Emmanuel Venisse, Vincent Siveton

Constructor Summary

Constructors
Constructor and Description
`CheckstyleReportListener(Configuration configuration)`
`CheckstyleReportListener(File sourceDirectory)`
`CheckstyleReportListener(File sourceDirectory, Configuration configuration)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addError(AuditEvent event)`
`void`	`addException(AuditEvent event, Throwable throwable)`
`void`	`addSourceDirectory(File sourceDirectory)`
`void`	`auditFinished(AuditEvent event)`
`void`	`auditStarted(AuditEvent event)`
`void`	`fileFinished(AuditEvent event)`
`void`	`fileStarted(AuditEvent event)`
`Configuration`	`getCheckstyleConfiguration()`
`CheckstyleResults`	`getResults()`
`SeverityLevel`	`getSeverityLevelFilter()`
`void`	`setCheckstyleConfiguration(Configuration checkstyleConfiguration)`
`void`	`setResults(CheckstyleResults results)`
`void`	`setSeverityLevelFilter(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,
                        Configuration configuration)
```
    Parameters:
    sourceDirectory - assume that is sourceDirectory is a not null directory and exists
    configuration - checkstyle configuration
    Since:
    
    2.5
  - CheckstyleReportListener
```
public CheckstyleReportListener(Configuration configuration)
```
    Parameters:
    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(SeverityLevel severityLevel)
```
    Parameters:
    severityLevel -
  - getSeverityLevelFilter
```
public SeverityLevel getSeverityLevelFilter()
```
    Returns:
  - auditStarted
```
public void auditStarted(AuditEvent event)
```
    Specified by:
    
    auditStarted in interface AuditListener
  - auditFinished
```
public void auditFinished(AuditEvent event)
```
    Specified by:
    
    auditFinished in interface AuditListener
  - fileStarted
```
public void fileStarted(AuditEvent event)
```
    Specified by:
    
    fileStarted in interface AuditListener
  - fileFinished
```
public void fileFinished(AuditEvent event)
```
    Specified by:
    
    fileFinished in interface AuditListener
  - addError
```
public void addError(AuditEvent event)
```
    Specified by:
    
    addError in interface AuditListener
  - addException
```
public void addException(AuditEvent event,
                Throwable throwable)
```
    Specified by:
    
    addException in interface AuditListener
  - getResults
```
public CheckstyleResults getResults()
```
    Returns:
  - setResults
```
public void setResults(CheckstyleResults results)
```
    Parameters:
    results -
  - getCheckstyleConfiguration
```
public Configuration getCheckstyleConfiguration()
```
    Since:
    
    2.5
  - setCheckstyleConfiguration
```
public void setCheckstyleConfiguration(Configuration checkstyleConfiguration)
```
    Since:
    
    2.5

Class CheckstyleReportListener

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CheckstyleReportListener

CheckstyleReportListener

CheckstyleReportListener

Method Detail

addSourceDirectory

setSeverityLevelFilter

getSeverityLevelFilter

auditStarted

auditFinished

fileStarted

fileFinished

addError

addException

getResults

setResults

getCheckstyleConfiguration

setCheckstyleConfiguration