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.scan.issue.filter; 021 022 023import javax.annotation.concurrent.ThreadSafe; 024 025import org.sonar.api.ExtensionPoint; 026import org.sonar.api.batch.ScannerSide; 027import org.sonarsource.api.sonarlint.SonarLintSide; 028 029@ScannerSide 030@SonarLintSide 031@ExtensionPoint 032@FunctionalInterface 033@ThreadSafe 034/** 035 * @since 5.3 036 */ 037public interface IssueFilter { 038 039 /** 040 * The <code>accept</code> method is called for each {@link FilterableIssue} created during analysis, to check if it has to be persisted. Examples of use cases are: 041 * <ul> 042 * <li>Ignoring or enforcing rules on specific resources</li> 043 * <li>Switching-off an issue based on its context (<code>//NOSONAR</code> comments, semantic annotations)</li> 044 * </ul> 045 * 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 046 * the {@link IssueFilterChain#accept} method, or return directly if the issue has to be accepted or not 047 * 048 * Implementations should be thread safe. 049 * 050 * @param issue the issue being filtered 051 * @param chain the rest of the filters 052 * @return <code>true</code> to accept the issue, <code>false</code> to reject it, {@link IssueFilterChain#accept} to let the other filters decide. 053 */ 054 boolean accept(FilterableIssue issue, IssueFilterChain chain); 055}