001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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 * SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
035 * </p>
036 * <ul>
037 * <li>
038 * Property {@code acceptOnMatch} - Control whether the filter accepts an audit
039 * event if and only if there is a match between the event's severity level and
040 * property severity. If acceptOnMatch is {@code false}, then the filter accepts
041 * an audit event if and only if there is not a match between the event's severity
042 * level and property severity.
043 * Type is {@code boolean}.
044 * Default value is {@code true}.
045 * </li>
046 * <li>
047 * Property {@code severity} - Specify the severity level of this filter.
048 * Type is {@code com.puppycrawl.tools.checkstyle.api.SeverityLevel}.
049 * Default value is {@code error}.
050 * </li>
051 * </ul>
052 *
053 * <p>
054 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
055 * </p>
056 *
057 * @since 3.2
058 */
059public class SeverityMatchFilter
060    extends AbstractAutomaticBean
061    implements Filter {
062
063    /** Specify the severity level of this filter. */
064    private SeverityLevel severity = SeverityLevel.ERROR;
065
066    /**
067     * Control whether the filter accepts an audit event if and only if there
068     * is a match between the event's severity level and property severity.
069     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
070     * if and only if there is not a match between the event's severity level
071     * and property severity.
072     */
073    private boolean acceptOnMatch = true;
074
075    /**
076     * Setter to specify the severity level of this filter.
077     *
078     * @param severity  The new severity level
079     * @see SeverityLevel
080     * @since 3.2
081     */
082    public final void setSeverity(SeverityLevel severity) {
083        this.severity = severity;
084    }
085
086    /**
087     * Setter to control whether the filter accepts an audit event if and only if there
088     * is a match between the event's severity level and property severity.
089     * If acceptOnMatch is {@code false}, then the filter accepts an audit event
090     * if and only if there is not a match between the event's severity level and property severity.
091     *
092     * @param acceptOnMatch if true, accept on matches; if
093     *     false, reject on matches.
094     * @since 3.2
095     */
096    public final void setAcceptOnMatch(boolean acceptOnMatch) {
097        this.acceptOnMatch = acceptOnMatch;
098    }
099
100    @Override
101    protected void finishLocalSetup() {
102        // No code by default
103    }
104
105    @Override
106    public boolean accept(AuditEvent event) {
107        final boolean severityMatches = severity == event.getSeverityLevel();
108        return acceptOnMatch == severityMatches;
109    }
110
111}