Package com.puppycrawl.tools.checkstyle.filters

Class SeverityMatchFilter

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
All Implemented Interfaces:
Configurable, Contextualizable, Filter
public class SeverityMatchFilter extends AbstractAutomaticBean implements Filter
Filter SeverityMatchFilter decides audit events according to the severity level of the event.

Notes: SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.

  • Property acceptOnMatch - Control whether the filter accepts an audit event if and only if there is a match between the event's severity level and property severity. If acceptOnMatch is false, then the filter accepts an audit event if and only if there is not a match between the event's severity level and property severity. Type is boolean. Default value is true.
  • Property severity - Specify the severity level of this filter. Type is com.puppycrawl.tools.checkstyle.api.SeverityLevel. Default value is error.

Parent is com.puppycrawl.tools.checkstyle.Checker

Since:
3.2

  • Field Details

    • severity

      private SeverityLevel severity
      Specify the severity level of this filter.

    • acceptOnMatch

      private boolean acceptOnMatch
      Control whether the filter accepts an audit event if and only if there is a match between the event's severity level and property severity. If acceptOnMatch is false, then the filter accepts an audit event if and only if there is not a match between the event's severity level and property severity.

  • Constructor Details

  • Method Details

    • setSeverity

      public final void setSeverity(SeverityLevel severity)
      Setter to specify the severity level of this filter.
      Parameters:
      severity - The new severity level
      Since:
      3.2
      See Also:

    • setAcceptOnMatch

      public final void setAcceptOnMatch(boolean acceptOnMatch)
      Setter to control whether the filter accepts an audit event if and only if there is a match between the event's severity level and property severity. If acceptOnMatch is false, then the filter accepts an audit event if and only if there is not a match between the event's severity level and property severity.
      Parameters:
      acceptOnMatch - if true, accept on matches; if false, reject on matches.
      Since:
      3.2

    • finishLocalSetup

      protected void finishLocalSetup()
      Description copied from class: AbstractAutomaticBean
      Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

      The default implementation does nothing.

      Specified by:
      finishLocalSetup in class AbstractAutomaticBean

    • accept

      public boolean accept(AuditEvent event)
      Description copied from interface: Filter
      Determines whether or not a filtered AuditEvent is accepted.
      Specified by:
      accept in interface Filter
      Parameters:
      event - the AuditEvent to filter.
      Returns:
      true if the event is accepted.