org.sonar.api.issue.batch.IssueFilterChain Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.issue.batch;

import org.sonar.api.issue.Issue;

/**
 * A filter chain is an object provided to issues filters for fine control over the filtering logic. Each filter has the choice to:
 * 
 *  Accept the issue
 *  Reject the issue
 *  Let downstream filters decide by passing the issue to the rest of the chain
 * 
 * @since 4.0
 */
public interface IssueFilterChain {

  /**
   * Called by a filter to let downstream filters decide the fate of the issue
   */
  boolean accept(Issue issue);
}