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