001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2013 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube 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 * SonarQube 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 */ 020 package org.sonar.api.issue; 021 022 import com.google.common.collect.Maps; 023 import org.apache.commons.lang.StringUtils; 024 025 import java.util.Map; 026 import java.util.Set; 027 028 /** 029 * Issue filter used to ignore issues created on lines commented with the tag "NOSONAR". 030 * <p/> 031 * Plugins, via {@link org.sonar.api.BatchExtension}s, must feed this filter by registering the 032 * lines that contain "NOSONAR". Note that filters are disabled for the issues reported by 033 * end-users from UI or web services. 034 * 035 * @since 3.6 036 */ 037 public class NoSonarFilter implements IssueFilter { 038 039 private final Map<String, Set<Integer>> noSonarLinesByResource = Maps.newHashMap(); 040 041 public NoSonarFilter addComponent(String componentKey, Set<Integer> noSonarLines) { 042 noSonarLinesByResource.put(componentKey, noSonarLines); 043 return this; 044 } 045 046 @Override 047 public boolean accept(Issue issue) { 048 boolean accepted = true; 049 if (issue.line() != null) { 050 Set<Integer> noSonarLines = noSonarLinesByResource.get(issue.componentKey()); 051 accepted = noSonarLines == null || !noSonarLines.contains(issue.line()); 052 if (!accepted && StringUtils.containsIgnoreCase(issue.ruleKey().rule(), "nosonar")) { 053 accepted = true; 054 } 055 } 056 return accepted; 057 } 058 }