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