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
,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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate com.puppycrawl.tools.checkstyle.api.Configuration
private String
private List
<com.puppycrawl.tools.checkstyle.api.AuditEvent> private CheckstyleResults
private com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Constructor Summary
ConstructorsConstructorDescriptionCheckstyleCheckerListener
(com.puppycrawl.tools.checkstyle.api.Configuration configuration) CheckstyleCheckerListener
(File sourceDirectory) CheckstyleCheckerListener
(File sourceDirectory, com.puppycrawl.tools.checkstyle.api.Configuration configuration) -
Method Summary
Modifier and TypeMethodDescriptionvoid
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) protected void
com.puppycrawl.tools.checkstyle.api.Configuration
com.puppycrawl.tools.checkstyle.api.SeverityLevel
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, getConfiguration, setupChild
-
Field Details
-
sourceDirectories
-
results
-
currentFile
-
events
-
severityLevel
private com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel -
checkstyleConfiguration
private com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfiguration
-
-
Constructor Details
-
CheckstyleCheckerListener
- Parameters:
sourceDirectory
- assume that issourceDirectory
is a not null directory and exists
-
CheckstyleCheckerListener
public CheckstyleCheckerListener(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 Details
-
addSourceDirectory
- 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
- 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
- Returns:
- The results of Checkstyle invocation.
-
setResults
- 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
-