Class CheckstyleCheckerListener
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
-
- All Implemented Interfaces:
AuditListener
,Configurable
,Contextualizable
,java.util.EventListener
public class CheckstyleCheckerListener extends AutomaticBean implements AuditListener
Listener in charge of receiving events from the Checker.- Author:
- Emmanuel Venisse, Vincent Siveton
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Constructor Summary
Constructors Constructor Description CheckstyleCheckerListener(Configuration configuration)
CheckstyleCheckerListener(java.io.File sourceDirectory)
CheckstyleCheckerListener(java.io.File sourceDirectory, Configuration configuration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addError(AuditEvent event)
void
addException(AuditEvent event, java.lang.Throwable throwable)
void
addSourceDirectory(java.io.File sourceDirectory)
void
auditFinished(AuditEvent event)
void
auditStarted(AuditEvent event)
void
fileFinished(AuditEvent event)
void
fileStarted(AuditEvent event)
protected void
finishLocalSetup()
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, getConfiguration, setupChild
-
-
-
-
Constructor Detail
-
CheckstyleCheckerListener
public CheckstyleCheckerListener(java.io.File sourceDirectory)
- Parameters:
sourceDirectory
- assume that issourceDirectory
is a not null directory and exists
-
CheckstyleCheckerListener
public CheckstyleCheckerListener(java.io.File sourceDirectory, Configuration configuration)
- Parameters:
sourceDirectory
- assume that issourceDirectory
is a not null directory and existsconfiguration
- Checkstyle configuration- Since:
- 2.5
-
CheckstyleCheckerListener
public CheckstyleCheckerListener(Configuration configuration)
- Parameters:
configuration
- Checkstyle configuration- Since:
- 2.5
-
-
Method Detail
-
addSourceDirectory
public void addSourceDirectory(java.io.File sourceDirectory)
- Parameters:
sourceDirectory
- assume that issourceDirectory
is a not null directory and exists
-
setSeverityLevelFilter
public void setSeverityLevelFilter(SeverityLevel severityLevel)
- Parameters:
severityLevel
- The severity level of the events to listen to.
-
getSeverityLevelFilter
public SeverityLevel getSeverityLevelFilter()
- Returns:
- The severity level of the events to listen to.
-
auditStarted
public void auditStarted(AuditEvent event)
- Specified by:
auditStarted
in interfaceAuditListener
-
auditFinished
public void auditFinished(AuditEvent event)
- Specified by:
auditFinished
in interfaceAuditListener
-
fileStarted
public void fileStarted(AuditEvent event)
- Specified by:
fileStarted
in interfaceAuditListener
-
fileFinished
public void fileFinished(AuditEvent event)
- Specified by:
fileFinished
in interfaceAuditListener
-
addError
public void addError(AuditEvent event)
- Specified by:
addError
in interfaceAuditListener
-
addException
public void addException(AuditEvent event, java.lang.Throwable throwable)
- Specified by:
addException
in interfaceAuditListener
-
finishLocalSetup
protected void finishLocalSetup() throws CheckstyleException
- Specified by:
finishLocalSetup
in classAutomaticBean
- Throws:
CheckstyleException
-
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 Configuration getCheckstyleConfiguration()
- Returns:
- The configuration of Checkstyle to use.
- Since:
- 2.5
-
setCheckstyleConfiguration
public void setCheckstyleConfiguration(Configuration checkstyleConfiguration)
- Parameters:
checkstyleConfiguration
- The configuration of Checkstyle to use.- Since:
- 2.5
-
-