org.sonar.api.scan.issue.filter.IssueFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation

Common library used by some SonarLint flavors

There is a newer version: 10.2.0.78029

/*
 * SonarQube
 * Copyright (C) 2009-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.scan.issue.filter;


import javax.annotation.concurrent.ThreadSafe;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.scanner.ScannerSide;
import org.sonarsource.api.sonarlint.SonarLintSide;

/**
 * @since 5.3
 * @since 7.6 moved to project container
 * @deprecated since 7.6
 */
@ScannerSide
@SonarLintSide
@ExtensionPoint
@FunctionalInterface
@ThreadSafe
@Deprecated
public interface IssueFilter {

  /**
   * The accept method is called for each {@link FilterableIssue} 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} method, or return directly if the issue has to be accepted or not
   * 
   * Implementations should be thread safe.
   * 
   * @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} to let the other filters decide.
   */
  boolean accept(FilterableIssue issue, IssueFilterChain chain);
}