001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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;
021
022/**
023 * An interface for filtering {@code TreeWalkerAuditEvent}.
024 *
025 */
026@FunctionalInterface
027public interface TreeWalkerFilter {
028
029    /**
030     * Determines whether or not a filtered {@code TreeWalkerAuditEvent} is accepted.
031     * An accepted event is kept in the final report as a violation; a rejected
032     * event is filtered out. In other words, returning {@code true} makes the
033     * violation appear in the report, while returning {@code false} suppresses
034     * it.
035     *
036     * @param treeWalkerAuditEvent the TreeWalkerAuditEvent to filter.
037     * @return true if the event is accepted and its violation should appear in
038     *     the final report; false to suppress the event.
039     */
040    boolean accept(TreeWalkerAuditEvent treeWalkerAuditEvent);
041
042}