001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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 * Accept violation to be present in audit report according to the
030 * <a href="https://checkstyle.org/config.html#Severity">severity level</a>.
031 * </div>
032 *
033 * <p>
034 * Notes:
035 * SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
036 * </p>
037 *
038 * <p>
039 * In Checkstyle, when a filter accepts a violation
040 * (i.e. {@code accept()} returns {@code true}), the violation is kept in the
041 * final report; to make a violation disappear from the report, the filter must
042 * reject it by returning {@code false}. For {@code SeverityMatchFilter}, set
043 * {@code severity} to the level you want to control and {@code acceptOnMatch}
044 * to {@code true} to keep matching violations in the final report, or to
045 * {@code false} to remove them from it.
046 * </p>
047 *
048 * @since 3.2
049 */
050public class SeverityMatchFilter
051    extends AbstractAutomaticBean
052    implements Filter {
053
054    /** Specify the severity level of this filter. */
055    private SeverityLevel severity = SeverityLevel.ERROR;
056
057    /**
058     * Control whether the filter accepts an audit event if and only if there
059     * is a match between the event's severity level and property severity.
060     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
061     * if and only if there is not a match between the event's severity level and property severity.
062     */
063    private boolean acceptOnMatch = true;
064
065    /**
066     * Creates a new {@code SeverityMatchFilter} instance.
067     */
068    public SeverityMatchFilter() {
069        // no code by default
070    }
071
072    /**
073     * Setter to specify the severity level of this filter.
074     *
075     * @param severity  The new severity level
076     * @see SeverityLevel
077     * @since 3.2
078     */
079    public final void setSeverity(SeverityLevel severity) {
080        this.severity = severity;
081    }
082
083    /**
084     * Setter to control whether the filter accepts an audit event if and only if there
085     * is a match between the event's severity level and property severity.
086     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
087     * if and only if there is not a match between the event's severity level and property severity.
088     *
089     * @param acceptOnMatch if true, accept on matches; if false, reject on matches.
090     * @since 3.2
091     */
092    public final void setAcceptOnMatch(boolean acceptOnMatch) {
093        this.acceptOnMatch = acceptOnMatch;
094    }
095
096    @Override
097    protected void finishLocalSetup() {
098        // No code by default
099    }
100
101    @Override
102    public boolean accept(AuditEvent event) {
103        final boolean severityMatches = severity == event.getSeverityLevel();
104        return acceptOnMatch == severityMatches;
105    }
106
107}