001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program 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 * This program 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.batch.sensor.coverage;
021
022import com.google.common.annotations.Beta;
023import com.google.common.collect.ImmutableSet;
024import java.util.Set;
025import org.sonar.api.measures.Metric;
026
027import static org.sonar.api.measures.CoreMetrics.CONDITIONS_BY_LINE;
028import static org.sonar.api.measures.CoreMetrics.CONDITIONS_TO_COVER;
029import static org.sonar.api.measures.CoreMetrics.COVERAGE_LINE_HITS_DATA;
030import static org.sonar.api.measures.CoreMetrics.COVERED_CONDITIONS_BY_LINE;
031import static org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_BY_LINE;
032import static org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_TO_COVER;
033import static org.sonar.api.measures.CoreMetrics.IT_COVERAGE_LINE_HITS_DATA;
034import static org.sonar.api.measures.CoreMetrics.IT_COVERED_CONDITIONS_BY_LINE;
035import static org.sonar.api.measures.CoreMetrics.IT_LINES_TO_COVER;
036import static org.sonar.api.measures.CoreMetrics.IT_UNCOVERED_CONDITIONS;
037import static org.sonar.api.measures.CoreMetrics.IT_UNCOVERED_LINES;
038import static org.sonar.api.measures.CoreMetrics.LINES_TO_COVER;
039import static org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_BY_LINE;
040import static org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_TO_COVER;
041import static org.sonar.api.measures.CoreMetrics.OVERALL_COVERAGE_LINE_HITS_DATA;
042import static org.sonar.api.measures.CoreMetrics.OVERALL_COVERED_CONDITIONS_BY_LINE;
043import static org.sonar.api.measures.CoreMetrics.OVERALL_LINES_TO_COVER;
044import static org.sonar.api.measures.CoreMetrics.OVERALL_UNCOVERED_CONDITIONS;
045import static org.sonar.api.measures.CoreMetrics.OVERALL_UNCOVERED_LINES;
046import static org.sonar.api.measures.CoreMetrics.UNCOVERED_CONDITIONS;
047import static org.sonar.api.measures.CoreMetrics.UNCOVERED_LINES;
048
049/**
050 * Different coverage categories.
051 * @since 5.2
052 */
053@Beta
054public enum CoverageType {
055
056  UNIT(LINES_TO_COVER, UNCOVERED_LINES, COVERAGE_LINE_HITS_DATA, CONDITIONS_TO_COVER, UNCOVERED_CONDITIONS, COVERED_CONDITIONS_BY_LINE, CONDITIONS_BY_LINE),
057  IT(IT_LINES_TO_COVER, IT_UNCOVERED_LINES, IT_COVERAGE_LINE_HITS_DATA, IT_CONDITIONS_TO_COVER, IT_UNCOVERED_CONDITIONS, IT_COVERED_CONDITIONS_BY_LINE, IT_CONDITIONS_BY_LINE),
058  OVERALL(OVERALL_LINES_TO_COVER, OVERALL_UNCOVERED_LINES, OVERALL_COVERAGE_LINE_HITS_DATA, OVERALL_CONDITIONS_TO_COVER, OVERALL_UNCOVERED_CONDITIONS,
059    OVERALL_COVERED_CONDITIONS_BY_LINE, OVERALL_CONDITIONS_BY_LINE);
060
061  private final Metric linesToCover;
062  private final Metric uncoveredLines;
063  private final Metric lineHitsData;
064  private final Metric conditionsToCover;
065  private final Metric uncoveredConditions;
066  private final Metric coveredConditionsByLine;
067  private final Metric conditionsByLine;
068  private final Set<Metric> all;
069
070  private CoverageType(Metric linesToCover, Metric uncoveredLines, Metric lineHitsData, Metric conditionsToCover, Metric uncoveredConditions, Metric coveredConditionsByLine,
071    Metric conditionsByLine) {
072    this.linesToCover = linesToCover;
073    this.uncoveredLines = uncoveredLines;
074    this.lineHitsData = lineHitsData;
075    this.conditionsToCover = conditionsToCover;
076    this.uncoveredConditions = uncoveredConditions;
077    this.coveredConditionsByLine = coveredConditionsByLine;
078    this.conditionsByLine = conditionsByLine;
079    this.all = ImmutableSet.of(linesToCover, uncoveredLines, lineHitsData, conditionsToCover, uncoveredConditions, coveredConditionsByLine, conditionsByLine);
080  }
081
082  public Set<Metric> allMetrics() {
083    return all;
084  }
085
086  public Metric linesToCover() {
087    return linesToCover;
088  }
089
090  public Metric uncoveredLines() {
091    return uncoveredLines;
092  }
093
094  public Metric lineHitsData() {
095    return lineHitsData;
096  }
097
098  public Metric conditionsToCover() {
099    return conditionsToCover;
100  }
101
102  public Metric uncoveredConditions() {
103    return uncoveredConditions;
104  }
105
106  public Metric coveredConditionsByLine() {
107    return coveredConditionsByLine;
108  }
109
110  public Metric conditionsByLine() {
111    return conditionsByLine;
112  }
113
114}