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.checks.SuppressWarningsHolder;
027
028/**
029 * A filter that suppresses warnings using the {@link SuppressWarnings}
030 * annotation.
031 * @author Trevor Robinson
032 */
033public class SuppressWarningsFilter
034    extends AutomaticBean
035    implements Filter {
036
037    @Override
038    protected void finishLocalSetup() throws CheckstyleException {
039        // No code by default
040    }
041
042    @Override
043    public boolean accept(AuditEvent event) {
044        return !SuppressWarningsHolder.isSuppressed(event);
045    }
046
047}