001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info AT sonarsource DOT com 005 * 006 * This program 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 * This program 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 */ 020package org.sonar.api.issue.batch; 021 022import org.sonar.api.ExtensionPoint; 023import org.sonar.api.batch.ScannerSide; 024import org.sonar.api.issue.Issue; 025import org.sonarsource.api.sonarlint.SonarLintSide; 026 027/** 028 * <p>An issue filter is an object that allows filtering of {@link Issue}s on batch side, preventing them from being persisted. 029 * @since 4.0 030 * @deprecated since 5.3. Use {@link org.sonar.api.scan.issue.filter.IssueFilter} instead. 031 */ 032@ScannerSide 033@SonarLintSide 034@ExtensionPoint 035@Deprecated 036public interface IssueFilter { 037 038 /** 039 * The <code>accept</code> method is called for each {@link Issue} created during analysis, to check if it has to be persisted. Examples of use cases are: 040 * <ul> 041 * <li>Ignoring or enforcing rules on specific resources</li> 042 * <li>Switching-off an issue based on its context (<code>//NOSONAR</code> comments, semantic annotations)</li> 043 * </ul> 044 * The <code>chain</code> 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 045 * the {@link IssueFilterChain#accept(org.sonar.api.issue.Issue)} method, or return directly if the issue has to be accepted or not 046 * @param issue the issue being filtered 047 * @param chain the rest of the filters 048 * @return <code>true</code> to accept the issue, <code>false</code> to reject it, {@link IssueFilterChain#accept(org.sonar.api.issue.Issue)} to let the other filters decide. 049 */ 050 boolean accept(Issue issue, IssueFilterChain chain); 051}