org.sonar.api.issue.batch.IssueFilter 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.BatchExtension;
import org.sonar.api.issue.Issue;

/**
 * An issue filter is an object that allows filtering of {@link Issue}s on batch side, preventing them from being persisted.
 * @since 4.0
 *
 */
public interface IssueFilter extends BatchExtension {

  /**
   * The accept method is called for each {@link Issue} created during analysis, to check if it has to be persisted. Examples of use cases are:
   * 
   *  Ignoring or enforcing rules on specific resources
   *  Switching-off an issue based on its context (//NOSONAR comments, semantic annotations)
   * 
   * The chain parameter allows for fine control of the filtering logic: it is each filter's duty to either pass the issue to the next filter, by calling
   * the {@link IssueFilterChain#accept(org.sonar.api.issue.Issue)} method, or return directly if the issue has to be accepted or not
   * @param issue the issue being filtered
   * @param chain the rest of the filters
   * @return true to accept the issue, false to reject it, {@link IssueFilterChain#accept(org.sonar.api.issue.Issue)} to let the other filters decide.
   */
  boolean accept(Issue issue, IssueFilterChain chain);
}