Uses of Interface
com.puppycrawl.tools.checkstyle.api.AuditListener
Packages that use AuditListener
Package
Description
Contains the implementation of the Checkstyle framework.
Contains code related to Checkstyle Ant Task.
Contains the core API to be used to implement checks.
-
Uses of AuditListener in com.puppycrawl.tools.checkstyle
Classes in com.puppycrawl.tools.checkstyle that implement AuditListenerModifier and TypeClassDescriptionclass
Simple plain logger for text output.class
Simple logger for metadata generator util.class
Simple SARIF logger.class
Simple XML logger.class
Generates suppressions.xml file, based on violations occurred.Fields in com.puppycrawl.tools.checkstyle with type parameters of type AuditListenerModifier and TypeFieldDescriptionprivate final List<AuditListener>
Checker.listeners
Vector of listeners.Methods in com.puppycrawl.tools.checkstyle that return AuditListenerModifier and TypeMethodDescriptionprivate static AuditListener
Main.createListener
(Main.OutputFormat format, Path outputLocation) This method creates in AuditListener an open stream for validation data, it must be closed byRootModule
(default implementation isChecker
) by callingauditFinished(AuditEvent)
.Main.OutputFormat.createListener
(OutputStream out, AbstractAutomaticBean.OutputStreamOptions options) Returns a new AuditListener for this OutputFormat.Methods in com.puppycrawl.tools.checkstyle with parameters of type AuditListenerModifier and TypeMethodDescriptionfinal void
Checker.addListener
(AuditListener listener) void
Checker.removeListener
(AuditListener listener) Removes a given listener. -
Uses of AuditListener in com.puppycrawl.tools.checkstyle.ant
Methods in com.puppycrawl.tools.checkstyle.ant that return AuditListenerModifier and TypeMethodDescriptionprivate AuditListener
CheckstyleAntTask.Formatter.createDefaultLogger
(org.apache.tools.ant.Task task) Creates default logger.CheckstyleAntTask.Formatter.createListener
(org.apache.tools.ant.Task task) Creates a listener for the formatter.private AuditListener
CheckstyleAntTask.Formatter.createSarifLogger
(org.apache.tools.ant.Task task) Creates Sarif logger.private AuditListener
CheckstyleAntTask.Formatter.createXmlLogger
(org.apache.tools.ant.Task task) Creates XML logger.private AuditListener[]
CheckstyleAntTask.getListeners()
Return the array of listeners set in this task. -
Uses of AuditListener in com.puppycrawl.tools.checkstyle.api
Classes in com.puppycrawl.tools.checkstyle.api that implement AuditListenerModifier and TypeClassDescriptionfinal class
An audit listener that counts how manyAuditEvents
of a given severity have been generated.Methods in com.puppycrawl.tools.checkstyle.api with parameters of type AuditListenerModifier and TypeMethodDescriptionvoid
RootModule.addListener
(AuditListener listener) Add the listener that will be used to receive events from the audit.