001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2018 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.api.AuditEvent; 023import com.puppycrawl.tools.checkstyle.api.AutomaticBean; 024import com.puppycrawl.tools.checkstyle.api.CheckstyleException; 025import com.puppycrawl.tools.checkstyle.api.Filter; 026import com.puppycrawl.tools.checkstyle.api.SeverityLevel; 027 028/** 029 * This is a very simple filter based on severity matching. 030 * The filter admits option severity and accepts an AuditEvent 031 * if its severity equals the filter's severity. 032 * @author Rick Giles 033 */ 034public class SeverityMatchFilter 035 extends AutomaticBean 036 implements Filter { 037 038 /** The severity level to accept. */ 039 private SeverityLevel severity = SeverityLevel.ERROR; 040 041 /** Whether to accept or reject on severity matches. */ 042 private boolean acceptOnMatch = true; 043 044 /** 045 * Sets the severity level. 046 * 047 * @param severity The new severity level 048 * @see SeverityLevel 049 */ 050 public final void setSeverity(SeverityLevel severity) { 051 this.severity = severity; 052 } 053 054 /** 055 * Sets whether to accept or reject on matching severity level. 056 * @param acceptOnMatch if true, accept on matches; if 057 * false, reject on matches. 058 */ 059 public final void setAcceptOnMatch(boolean acceptOnMatch) { 060 this.acceptOnMatch = acceptOnMatch; 061 } 062 063 @Override 064 protected void finishLocalSetup() throws CheckstyleException { 065 // No code by default 066 } 067 068 @Override 069 public boolean accept(AuditEvent event) { 070 final boolean severityMatches = severity == event.getSeverityLevel(); 071 return acceptOnMatch == severityMatches; 072 } 073 074}