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 */
020package org.sonar.api.checks;
021
022import com.google.common.collect.Maps;
023import org.apache.commons.lang.StringUtils;
024import org.sonar.api.resources.Resource;
025import org.sonar.api.rules.Violation;
026import org.sonar.api.rules.ViolationFilter;
027
028import java.util.Map;
029import java.util.Set;
030
031/**
032 * @since 2.1
033 * @deprecated in 3.6. Replaced by {@link org.sonar.api.issue.NoSonarFilter}
034 */
035@Deprecated
036public class NoSonarFilter implements ViolationFilter {
037
038  private final Map<Resource, Set<Integer>> noSonarLinesByResource = Maps.newHashMap();
039
040  public void addResource(Resource resource, Set<Integer> noSonarLines) {
041    if (resource != null && noSonarLines != null) {
042      noSonarLinesByResource.put(resource, noSonarLines);
043    }
044  }
045
046  public boolean isIgnored(Violation violation) {
047    boolean ignored = false;
048    if (violation.getResource() != null && violation.getLineId() != null) {
049      Set<Integer> noSonarLines = noSonarLinesByResource.get(violation.getResource());
050      ignored = noSonarLines != null && noSonarLines.contains(violation.getLineId());
051      if (ignored && violation.getRule() != null && StringUtils.containsIgnoreCase(violation.getRule().getKey(), "nosonar")) {
052        ignored = false;
053      }
054    }
055    return ignored;
056  }
057}