001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 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.checks;
021    
022    import com.google.common.collect.Maps;
023    import org.apache.commons.lang.StringUtils;
024    import org.sonar.api.batch.SensorContext;
025    import org.sonar.api.resources.Resource;
026    import org.sonar.api.rules.Violation;
027    import org.sonar.api.rules.ViolationFilter;
028    
029    import java.util.Map;
030    import java.util.Set;
031    
032    /**
033     * @since 2.1
034     * @deprecated in 3.6. Replaced by {@link org.sonar.api.issue.NoSonarFilter}
035     */
036    @Deprecated
037    public class NoSonarFilter implements ViolationFilter {
038    
039      private final Map<Resource, Set<Integer>> noSonarLinesByResource = Maps.newHashMap();
040      private SensorContext context;
041    
042      public NoSonarFilter(SensorContext context) {
043        this.context = context;
044      }
045    
046      public void addResource(Resource model, Set<Integer> noSonarLines) {
047        if (model != null && noSonarLines != null) {
048          // Reload resource to handle backward compatibility of resource keys
049          Resource resource = context.getResource(model);
050          if (resource != null) {
051            noSonarLinesByResource.put(resource, noSonarLines);
052          }
053        }
054      }
055    
056      public boolean isIgnored(Violation violation) {
057        boolean ignored = false;
058        if (violation.getResource() != null && violation.getLineId() != null) {
059          Set<Integer> noSonarLines = noSonarLinesByResource.get(violation.getResource());
060          ignored = noSonarLines != null && noSonarLines.contains(violation.getLineId());
061          if (ignored && violation.getRule() != null && StringUtils.containsIgnoreCase(violation.getRule().getKey(), "nosonar")) {
062            ignored = false;
063          }
064        }
065        return ignored;
066      }
067    }