001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2025 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.filters;
021
022import com.puppycrawl.tools.checkstyle.AbstractAutomaticBean;
023import com.puppycrawl.tools.checkstyle.api.AuditEvent;
024import com.puppycrawl.tools.checkstyle.api.Filter;
025import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
026
027/**
028 * <div>
029 * Filter {@code SeverityMatchFilter} decides audit events according to the
030 * <a href="https://checkstyle.org/config.html#Severity">severity level</a> of the event.
031 * </div>
032 *
033 * <p>
034 * Notes:
035 * SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
036 * </p>
037 * <ul>
038 * <li>
039 * Property {@code acceptOnMatch} - Control whether the filter accepts an audit
040 * event if and only if there is a match between the event's severity level and
041 * property severity. If acceptOnMatch is {@code false}, then the filter accepts
042 * an audit event if and only if there is not a match between the event's severity
043 * level and property severity.
044 * Type is {@code boolean}.
045 * Default value is {@code true}.
046 * </li>
047 * <li>
048 * Property {@code severity} - Specify the severity level of this filter.
049 * Type is {@code com.puppycrawl.tools.checkstyle.api.SeverityLevel}.
050 * Default value is {@code error}.
051 * </li>
052 * </ul>
053 *
054 * <p>
055 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
056 * </p>
057 *
058 * @since 3.2
059 */
060public class SeverityMatchFilter
061    extends AbstractAutomaticBean
062    implements Filter {
063
064    /** Specify the severity level of this filter. */
065    private SeverityLevel severity = SeverityLevel.ERROR;
066
067    /**
068     * Control whether the filter accepts an audit event if and only if there
069     * is a match between the event's severity level and property severity.
070     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
071     * if and only if there is not a match between the event's severity level
072     * and property severity.
073     */
074    private boolean acceptOnMatch = true;
075
076    /**
077     * Setter to specify the severity level of this filter.
078     *
079     * @param severity  The new severity level
080     * @see SeverityLevel
081     * @since 3.2
082     */
083    public final void setSeverity(SeverityLevel severity) {
084        this.severity = severity;
085    }
086
087    /**
088     * Setter to control whether the filter accepts an audit event if and only if there
089     * is a match between the event's severity level and property severity.
090     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
091     * if and only if there is not a match between the event's severity level and property severity.
092     *
093     * @param acceptOnMatch if true, accept on matches; if
094     *     false, reject on matches.
095     * @since 3.2
096     */
097    public final void setAcceptOnMatch(boolean acceptOnMatch) {
098        this.acceptOnMatch = acceptOnMatch;
099    }
100
101    @Override
102    protected void finishLocalSetup() {
103        // No code by default
104    }
105
106    @Override
107    public boolean accept(AuditEvent event) {
108        final boolean severityMatches = severity == event.getSeverityLevel();
109        return acceptOnMatch == severityMatches;
110    }
111
112}