001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 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//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.filters; 020 021import com.puppycrawl.tools.checkstyle.api.AuditEvent; 022import com.puppycrawl.tools.checkstyle.api.AutomaticBean; 023import com.puppycrawl.tools.checkstyle.api.Filter; 024import com.puppycrawl.tools.checkstyle.api.SeverityLevel; 025 026/** 027 * This is a very simple filter based on severity matching. 028 * The filter admits option severity and accepts an AuditEvent 029 * if its severity equals the filter's severity. 030 * @author Rick Giles 031 */ 032public class SeverityMatchFilter 033 extends AutomaticBean 034 implements Filter 035{ 036 /** the severity level to accept */ 037 private SeverityLevel severityLevel = SeverityLevel.ERROR; 038 039 /** whether to accept or reject on severity matches */ 040 private boolean acceptOnMatch = true; 041 042 /** 043 * Sets the severity level. The string should be one of the names 044 * defined in the <code>SeverityLevel</code> class. 045 * 046 * @param severity The new severity level 047 * @see SeverityLevel 048 */ 049 public final void setSeverity(String severity) 050 { 051 severityLevel = SeverityLevel.getInstance(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 { 061 this.acceptOnMatch = acceptOnMatch; 062 } 063 064 /** {@inheritDoc} */ 065 @Override 066 public boolean accept(AuditEvent event) 067 { 068 final boolean result = severityLevel.equals(event.getSeverityLevel()); 069 if (acceptOnMatch) { 070 return result; 071 } 072 return !result; 073 } 074}