Uses of Class
com.puppycrawl.tools.checkstyle.api.AuditEvent
Packages that use AuditEvent
Package
Description
Contains the implementation of the Checkstyle framework.
Contains the core API to be used to implement checks.
Contains the checks that are bundled with the main distribution.
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 AuditEventModifier and TypeFieldDescriptionprivate final List<AuditEvent> XMLLogger.FileMessages.errorsThe file error events.Methods in com.puppycrawl.tools.checkstyle that return types with arguments of type AuditEventModifier and TypeMethodDescriptionXMLLogger.FileMessages.getErrors()Returns the file error events.Methods in com.puppycrawl.tools.checkstyle with parameters of type AuditEventModifier and TypeMethodDescriptionvoidDefaultLogger.addError(AuditEvent event) Print an Emacs compliant line on the error stream.voidSarifLogger.addError(AuditEvent event) Notify that an audit error was discovered on a specific file.voidXMLLogger.addError(AuditEvent event) voidXMLLogger.FileMessages.addError(AuditEvent event) Adds the given error event to the messages.voidXpathFileGeneratorAuditListener.addError(AuditEvent event) voidDefaultLogger.addException(AuditEvent event, Throwable throwable) voidSarifLogger.addException(AuditEvent event, Throwable throwable) Notify that an exception happened while performing audit.voidXMLLogger.addException(AuditEvent event, Throwable throwable) voidXpathFileGeneratorAuditListener.addException(AuditEvent event, Throwable throwable) voidDefaultLogger.auditFinished(AuditEvent event) voidSarifLogger.auditFinished(AuditEvent event) Notify that the audit is finished.voidXMLLogger.auditFinished(AuditEvent event) voidXpathFileGeneratorAuditListener.auditFinished(AuditEvent event) voidDefaultLogger.auditStarted(AuditEvent event) voidSarifLogger.auditStarted(AuditEvent event) voidXMLLogger.auditStarted(AuditEvent event) voidXpathFileGeneratorAuditListener.auditStarted(AuditEvent event) private static intAuditEventDefaultFormatter.calculateBufferLength(AuditEvent event, int severityLevelNameLength) Returns the length of the buffer for StringBuilder.voidDefaultLogger.fileFinished(AuditEvent event) voidSarifLogger.fileFinished(AuditEvent event) voidXMLLogger.fileFinished(AuditEvent event) voidXpathFileGeneratorAuditListener.fileFinished(AuditEvent event) voidDefaultLogger.fileStarted(AuditEvent event) voidSarifLogger.fileStarted(AuditEvent event) voidXMLLogger.fileStarted(AuditEvent event) voidXpathFileGeneratorAuditListener.fileStarted(AuditEvent event) static StringXpathFileGeneratorAstFilter.findCorrespondingXpathQuery(AuditEvent event) Returns xpath query corresponding to violation of theTreeWalkerAuditEventobject which points to the same AST element as specifiedAuditEventobject.AuditEventDefaultFormatter.format(AuditEvent event) AuditEventFormatter.format(AuditEvent event) Formats an event message.private static StringAuditEventDefaultFormatter.getCheckShortName(AuditEvent event) Returns check name without 'Check' suffix.private voidXMLLogger.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 AuditEventModifier and TypeMethodDescriptionbooleanFilter.accept(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.booleanFilterSet.accept(AuditEvent event) voidAuditListener.addError(AuditEvent event) Notify that an audit error was discovered on a specific file.voidSeverityLevelCounter.addError(AuditEvent event) voidAuditListener.addException(AuditEvent event, Throwable throwable) Notify that an exception happened while performing audit.voidSeverityLevelCounter.addException(AuditEvent event, Throwable throwable) voidAuditListener.auditFinished(AuditEvent event) Notify that the audit is finished.voidSeverityLevelCounter.auditFinished(AuditEvent event) voidAuditListener.auditStarted(AuditEvent event) Notify that the audit is about to start.voidSeverityLevelCounter.auditStarted(AuditEvent event) voidAuditListener.fileFinished(AuditEvent event) Notify that audit is finished on a specific file.voidSeverityLevelCounter.fileFinished(AuditEvent event) voidAuditListener.fileStarted(AuditEvent event) Notify that audit is about to start on a specific file.voidSeverityLevelCounter.fileStarted(AuditEvent event) -
Uses of AuditEvent in com.puppycrawl.tools.checkstyle.checks
Methods in com.puppycrawl.tools.checkstyle.checks with parameters of type AuditEventModifier and TypeMethodDescriptionstatic booleanSuppressWarningsHolder.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 AuditEventModifier and TypeMethodDescriptionbooleanSeverityMatchFilter.accept(AuditEvent event) booleanSuppressFilterElement.accept(AuditEvent event) booleanSuppressionFilter.accept(AuditEvent event) booleanSuppressionSingleFilter.accept(AuditEvent event) booleanSuppressWarningsFilter.accept(AuditEvent event) booleanSuppressWithPlainTextCommentFilter.accept(AuditEvent event) private static SuppressWithPlainTextCommentFilter.SuppressionSuppressWithPlainTextCommentFilter.getNearestSuppression(List<SuppressWithPlainTextCommentFilter.Suppression> suppressions, AuditEvent event) Finds the nearestSuppressWithPlainTextCommentFilter.Suppressioninstance which can suppress the givenAuditEvent.private booleanSuppressWithPlainTextCommentFilter.Suppression.isCheckMatch(AuditEvent event) Checks whetherAuditEventsource name matches the check format.private booleanSuppressFilterElement.isFileNameAndModuleNameMatching(AuditEvent event) Is matching by file name, module id, and Check name.private booleanSuppressWithPlainTextCommentFilter.Suppression.isIdMatch(AuditEvent event) Checks whether theAuditEventmodule ID matches the ID format.private booleanSuppressWithPlainTextCommentFilter.Suppression.isInScopeOfSuppression(AuditEvent event) Checks whetherAuditEventis in the scope of the suppression.private booleanSuppressFilterElement.isLineAndColumnMatching(AuditEvent event) Whether line and column match.private booleanSuppressWithPlainTextCommentFilter.Suppression.isMatch(AuditEvent event) Checks whether the suppression matches the givenAuditEvent.private booleanSuppressWithPlainTextCommentFilter.Suppression.isMessageMatch(AuditEvent event) Checks whether theAuditEventmessage matches the message format.private booleanSuppressFilterElement.isMessageNameMatching(AuditEvent event) Is matching by message.