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.
-
-
Field Summary
Fields Modifier and Type Field 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 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
All Methods Instance Methods Concrete Methods Modifier and Type Method 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)
protected void
finishLocalSetup()
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)
-
-
-
Field Detail
-
sourceDirectories
private final 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 issourceDirectory
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 issourceDirectory
is a not null directory and existsconfiguration
- 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 issourceDirectory
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 interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
auditFinished
public void auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
- Specified by:
auditFinished
in interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
fileStarted
public void fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
- Specified by:
fileStarted
in interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
fileFinished
public void fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
- Specified by:
fileFinished
in interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
addError
public void addError(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
- Specified by:
addError
in interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
addException
public void addException(com.puppycrawl.tools.checkstyle.api.AuditEvent event, java.lang.Throwable throwable)
- Specified by:
addException
in interfacecom.puppycrawl.tools.checkstyle.api.AuditListener
-
finishLocalSetup
protected void finishLocalSetup() throws com.puppycrawl.tools.checkstyle.api.CheckstyleException
- Specified by:
finishLocalSetup
in classcom.puppycrawl.tools.checkstyle.api.AutomaticBean
- Throws:
com.puppycrawl.tools.checkstyle.api.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 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
-
-