001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.checks;
021    
022    import org.sonar.api.resources.Resource;
023    import org.sonar.api.rules.Violation;
024    import org.sonar.api.rules.ViolationFilter;
025    
026    import java.util.HashMap;
027    import java.util.Map;
028    import java.util.Set;
029    
030    /**
031     * @since 2.1
032     */
033    public class NoSonarFilter implements ViolationFilter {
034    
035      private final Map<Resource, Set<Integer>> noSonarLinesByResource = new HashMap<Resource, Set<Integer>>();
036    
037      public void addResource(Resource resource, Set<Integer> noSonarLines) {
038        if (resource != null && noSonarLines != null) {
039          noSonarLinesByResource.put(resource, noSonarLines);
040        }
041      }
042    
043      public boolean isIgnored(Violation violation) {
044        if (violation.getResource() != null && violation.getLineId() != null) {
045          Set<Integer> noSonarLines = noSonarLinesByResource.get(violation.getResource());
046          return (noSonarLines != null && noSonarLines.contains(violation.getLineId()));
047        }
048        return false;
049      }
050    }