Uses of Class
com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Packages that use AuditEvent Package Description com.puppycrawl.tools.checkstyle Contains the implementation of the Checkstyle framework.com.puppycrawl.tools.checkstyle.api Contains the core API to be used to implement checks.com.puppycrawl.tools.checkstyle.checks Contains the checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.filters Contains the filters that are bundled with the main distribution. -
-
Uses of AuditEvent in com.puppycrawl.tools.checkstyle
Fields in com.puppycrawl.tools.checkstyle with type parameters of type AuditEvent Modifier and Type Field Description private List<AuditEvent>
XMLLogger.FileMessages. errors
The file error events.Methods in com.puppycrawl.tools.checkstyle that return types with arguments of type AuditEvent Modifier and Type Method Description List<AuditEvent>
XMLLogger.FileMessages. getErrors()
Returns the file error events.Methods in com.puppycrawl.tools.checkstyle with parameters of type AuditEvent Modifier and Type Method Description void
DefaultLogger. addError(AuditEvent event)
Print an Emacs compliant line on the error stream.void
MetadataGeneratorLogger. addError(AuditEvent event)
void
SarifLogger. addError(AuditEvent event)
void
XMLLogger. addError(AuditEvent event)
void
XMLLogger.FileMessages. addError(AuditEvent event)
Adds the given error event to the messages.void
XpathFileGeneratorAuditListener. addError(AuditEvent event)
void
DefaultLogger. addException(AuditEvent event, Throwable throwable)
void
MetadataGeneratorLogger. addException(AuditEvent event, Throwable throwable)
void
SarifLogger. addException(AuditEvent event, Throwable throwable)
void
XMLLogger. addException(AuditEvent event, Throwable throwable)
void
XpathFileGeneratorAuditListener. addException(AuditEvent event, Throwable throwable)
void
DefaultLogger. auditFinished(AuditEvent event)
void
MetadataGeneratorLogger. auditFinished(AuditEvent event)
void
SarifLogger. auditFinished(AuditEvent event)
void
XMLLogger. auditFinished(AuditEvent event)
void
XpathFileGeneratorAuditListener. auditFinished(AuditEvent event)
void
DefaultLogger. auditStarted(AuditEvent event)
void
MetadataGeneratorLogger. auditStarted(AuditEvent event)
void
SarifLogger. auditStarted(AuditEvent event)
void
XMLLogger. auditStarted(AuditEvent event)
void
XpathFileGeneratorAuditListener. auditStarted(AuditEvent event)
void
DefaultLogger. fileFinished(AuditEvent event)
void
MetadataGeneratorLogger. fileFinished(AuditEvent event)
void
SarifLogger. fileFinished(AuditEvent event)
void
XMLLogger. fileFinished(AuditEvent event)
void
XpathFileGeneratorAuditListener. fileFinished(AuditEvent event)
void
DefaultLogger. fileStarted(AuditEvent event)
void
MetadataGeneratorLogger. fileStarted(AuditEvent event)
void
SarifLogger. fileStarted(AuditEvent event)
void
XMLLogger. fileStarted(AuditEvent event)
void
XpathFileGeneratorAuditListener. fileStarted(AuditEvent event)
static String
XpathFileGeneratorAstFilter. findCorrespondingXpathQuery(AuditEvent event)
Returns xpath query corresponding to violation of theTreeWalkerAuditEvent
object which points to the same AST element as specifiedAuditEvent
object.String
AuditEventDefaultFormatter. format(AuditEvent event)
String
AuditEventFormatter. format(AuditEvent event)
Formats an event message.private static String
AuditEventDefaultFormatter. getCheckShortName(AuditEvent event)
Returns check name without 'Check' suffix.private static StringBuilder
AuditEventDefaultFormatter. initStringBuilderWithOptimalBuffer(AuditEvent event, String severityLevelName)
Returns the StringBuilder that should avoid StringBuffer.expandCapacity.private void
XMLLogger. writeFileError(AuditEvent event)
Outputs the given event to the writer. -
Uses of AuditEvent in com.puppycrawl.tools.checkstyle.api
Methods in com.puppycrawl.tools.checkstyle.api with parameters of type AuditEvent Modifier and Type Method Description boolean
Filter. accept(AuditEvent event)
Determines whether or not a filtered AuditEvent is accepted.boolean
FilterSet. accept(AuditEvent event)
void
AuditListener. addError(AuditEvent event)
Notify that an audit error was discovered on a specific file.void
SeverityLevelCounter. addError(AuditEvent event)
void
AuditListener. addException(AuditEvent event, Throwable throwable)
Notify that an exception happened while performing audit.void
SeverityLevelCounter. addException(AuditEvent event, Throwable throwable)
void
AuditListener. auditFinished(AuditEvent event)
Notify that the audit is finished.void
SeverityLevelCounter. auditFinished(AuditEvent event)
void
AuditListener. auditStarted(AuditEvent event)
Notify that the audit is about to start.void
SeverityLevelCounter. auditStarted(AuditEvent event)
void
AuditListener. fileFinished(AuditEvent event)
Notify that audit is finished on a specific file.void
SeverityLevelCounter. fileFinished(AuditEvent event)
void
AuditListener. fileStarted(AuditEvent event)
Notify that audit is about to start on a specific file.void
SeverityLevelCounter. fileStarted(AuditEvent event)
-
Uses of AuditEvent in com.puppycrawl.tools.checkstyle.checks
Methods in com.puppycrawl.tools.checkstyle.checks with parameters of type AuditEvent Modifier and Type Method Description static boolean
SuppressWarningsHolder. isSuppressed(AuditEvent event)
Checks for a suppression of a check with the given source name and location in the last file processed. -
Uses of AuditEvent in com.puppycrawl.tools.checkstyle.filters
Methods in com.puppycrawl.tools.checkstyle.filters with parameters of type AuditEvent Modifier and Type Method Description boolean
SeverityMatchFilter. accept(AuditEvent event)
boolean
SuppressFilterElement. accept(AuditEvent event)
boolean
SuppressionFilter. accept(AuditEvent event)
boolean
SuppressionSingleFilter. accept(AuditEvent event)
boolean
SuppressWarningsFilter. accept(AuditEvent event)
boolean
SuppressWithNearbyTextFilter. accept(AuditEvent event)
boolean
SuppressWithPlainTextCommentFilter. accept(AuditEvent event)
private static Optional<SuppressWithNearbyTextFilter.Suppression>
SuppressWithNearbyTextFilter. getNearestSuppression(Collection<SuppressWithNearbyTextFilter.Suppression> suppressions, AuditEvent event)
Finds the nearestSuppressWithNearbyTextFilter.Suppression
instance which can suppress the givenAuditEvent
.private static SuppressWithPlainTextCommentFilter.Suppression
SuppressWithPlainTextCommentFilter. getNearestSuppression(Collection<SuppressWithPlainTextCommentFilter.Suppression> suppressions, AuditEvent event)
Finds the nearestSuppressWithPlainTextCommentFilter.Suppression
instance which can suppress the givenAuditEvent
.private boolean
SuppressWithNearbyTextFilter.Suppression. isCheckMatch(AuditEvent event)
Checks whetherAuditEvent
source name matches the check pattern.private boolean
SuppressWithPlainTextCommentFilter.Suppression. isCheckMatch(AuditEvent event)
Checks whetherAuditEvent
source name matches the check format.private boolean
SuppressFilterElement. isFileNameAndModuleNameMatching(AuditEvent event)
Is matching by file name, module id, and Check name.private boolean
SuppressWithNearbyTextFilter.Suppression. isIdMatch(AuditEvent event)
Checks whether theAuditEvent
module ID matches the ID pattern.private boolean
SuppressWithPlainTextCommentFilter.Suppression. isIdMatch(AuditEvent event)
Checks whether theAuditEvent
module ID matches the ID format.private boolean
SuppressWithNearbyTextFilter.Suppression. isInScopeOfSuppression(AuditEvent event)
Checks whether theAuditEvent
is in the scope of the suppression.private boolean
SuppressWithPlainTextCommentFilter.Suppression. isInScopeOfSuppression(AuditEvent event)
Checks whetherAuditEvent
is in the scope of the suppression.private boolean
SuppressFilterElement. isLineAndColumnMatching(AuditEvent event)
Whether line and column match.private boolean
SuppressWithNearbyTextFilter.Suppression. isMatch(AuditEvent event)
Determines whether the source of an audit event matches the text of this suppression.private boolean
SuppressWithPlainTextCommentFilter.Suppression. isMatch(AuditEvent event)
Checks whether the suppression matches the givenAuditEvent
.private boolean
SuppressWithNearbyTextFilter.Suppression. isMessageMatch(AuditEvent event)
Checks whether theAuditEvent
message matches the message pattern.private boolean
SuppressWithPlainTextCommentFilter.Suppression. isMessageMatch(AuditEvent event)
Checks whether theAuditEvent
message matches the message format.private boolean
SuppressFilterElement. isMessageNameMatching(AuditEvent event)
Is matching by message.
-