1 /////////////////////////////////////////////////////////////////////////////////////////////// 2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules. 3 // Copyright (C) 2001-2025 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 * <ul> 38 * <li> 39 * Property {@code acceptOnMatch} - Control whether the filter accepts an audit 40 * event if and only if there is a match between the event's severity level and 41 * property severity. If acceptOnMatch is {@code false}, then the filter accepts 42 * an audit event if and only if there is not a match between the event's severity 43 * level and property severity. 44 * Type is {@code boolean}. 45 * Default value is {@code true}. 46 * </li> 47 * <li> 48 * Property {@code severity} - Specify the severity level of this filter. 49 * Type is {@code com.puppycrawl.tools.checkstyle.api.SeverityLevel}. 50 * Default value is {@code error}. 51 * </li> 52 * </ul> 53 * 54 * <p> 55 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker} 56 * </p> 57 * 58 * @since 3.2 59 */ 60 public class SeverityMatchFilter 61 extends AbstractAutomaticBean 62 implements Filter { 63 64 /** Specify the severity level of this filter. */ 65 private SeverityLevel severity = SeverityLevel.ERROR; 66 67 /** 68 * Control whether the filter accepts an audit event if and only if there 69 * is a match between the event's severity level and property severity. 70 * If acceptOnMatch is {@code false}, then the filter accepts an audit event 71 * if and only if there is not a match between the event's severity level 72 * and property severity. 73 */ 74 private boolean acceptOnMatch = true; 75 76 /** 77 * Setter to specify the severity level of this filter. 78 * 79 * @param severity The new severity level 80 * @see SeverityLevel 81 * @since 3.2 82 */ 83 public final void setSeverity(SeverityLevel severity) { 84 this.severity = severity; 85 } 86 87 /** 88 * Setter to control whether the filter accepts an audit event if and only if there 89 * is a match between the event's severity level and property severity. 90 * If acceptOnMatch is {@code false}, then the filter accepts an audit event 91 * if and only if there is not a match between the event's severity level and property severity. 92 * 93 * @param acceptOnMatch if true, accept on matches; if 94 * false, reject on matches. 95 * @since 3.2 96 */ 97 public final void setAcceptOnMatch(boolean acceptOnMatch) { 98 this.acceptOnMatch = acceptOnMatch; 99 } 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 }