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.squid.api;
021    
022    import java.util.HashSet;
023    import java.util.Set;
024    
025    import org.sonar.squid.measures.Metric;
026    
027    public class SourceFile extends SourceCode {
028    
029      Set<Integer> noSonarTagLines = new HashSet<Integer>();
030    
031      public SourceFile(String key) {
032        super(key);
033      }
034    
035      public SourceFile(String key, String fileName) {
036        super(key, fileName);
037      }
038    
039      public static SourceFile create(SourcePackage parentPackage, String fileName) {
040        StringBuilder key = new StringBuilder();
041        if (parentPackage != null) {
042          key.append(parentPackage.getKey());
043          key.append(".");
044        }
045        key.append(fileName);
046        return new SourceFile(key.toString(), fileName);
047      }
048    
049      @Override
050      protected void initializeMeasures() {
051        setMeasure(Metric.FILES, 1);
052      }
053    
054      @Override
055      protected void updateMeasuresAfterConsolidation() {
056      }
057    
058      public Set<Integer> getNotSonarTagLines() {
059        return noSonarTagLines;
060      }
061    
062      public boolean isThereNoSonarTagAtLine(int lineNumber) {
063        return noSonarTagLines.contains(lineNumber);
064      }
065    
066      public void addNotSonarTagLines(Set<Integer> noSonarTagLines) {
067        this.noSonarTagLines.addAll(noSonarTagLines);
068      }
069    }