1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.filters;
21
22 import com.puppycrawl.tools.checkstyle.AbstractAutomaticBean;
23 import com.puppycrawl.tools.checkstyle.api.AuditEvent;
24 import com.puppycrawl.tools.checkstyle.api.Filter;
25 import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
26
27 /**
28 * <div>
29 * Filter {@code SeverityMatchFilter} decides audit events according to the
30 * <a href="https://checkstyle.org/config.html#Severity">severity level</a> of the event.
31 * </div>
32 *
33 * <p>
34 * Notes:
35 * SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
36 * </p>
37 *
38 * @since 3.2
39 */
40 public class SeverityMatchFilter
41 extends AbstractAutomaticBean
42 implements Filter {
43
44 /** Specify the severity level of this filter. */
45 private SeverityLevel severity = SeverityLevel.ERROR;
46
47 /**
48 * Control whether the filter accepts an audit event if and only if there
49 * is a match between the event's severity level and property severity.
50 * If acceptOnMatch is {@code false}, then the filter accepts an audit event
51 * if and only if there is not a match between the event's severity level
52 * and property severity.
53 */
54 private boolean acceptOnMatch = true;
55
56 /**
57 * Creates a new {@code SeverityMatchFilter} instance.
58 */
59 public SeverityMatchFilter() {
60 // no code by default
61 }
62
63 /**
64 * Setter to specify the severity level of this filter.
65 *
66 * @param severity The new severity level
67 * @see SeverityLevel
68 * @since 3.2
69 */
70 public final void setSeverity(SeverityLevel severity) {
71 this.severity = severity;
72 }
73
74 /**
75 * Setter to control whether the filter accepts an audit event if and only if there
76 * is a match between the event's severity level and property severity.
77 * If acceptOnMatch is {@code false}, then the filter accepts an audit event
78 * if and only if there is not a match between the event's severity level and property severity.
79 *
80 * @param acceptOnMatch if true, accept on matches; if
81 * false, reject on matches.
82 * @since 3.2
83 */
84 public final void setAcceptOnMatch(boolean acceptOnMatch) {
85 this.acceptOnMatch = acceptOnMatch;
86 }
87
88 @Override
89 protected void finishLocalSetup() {
90 // No code by default
91 }
92
93 @Override
94 public boolean accept(AuditEvent event) {
95 final boolean severityMatches = severity == event.getSeverityLevel();
96 return acceptOnMatch == severityMatches;
97 }
98
99 }