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