001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * SonarQube is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.issue.batch;
021    
022    import org.sonar.api.issue.Issue;
023    
024    /**
025     * A filter chain is an object provided to issues filters for fine control over the filtering logic. Each filter has the choice to:
026     * <ul>
027     *  <li>Accept the issue</li>
028     *  <li>Reject the issue</li>
029     *  <li>Let downstream filters decide by passing the issue to the rest of the chain</li>
030     * </ul>
031     * @since 4.0
032     */
033    public interface IssueFilterChain {
034    
035      /**
036       * Called by a filter to let downstream filters decide the fate of the issue
037       */
038      boolean accept(Issue issue);
039    }