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 */
020package org.sonar.api.batch.sensor.coverage;
021
022import com.google.common.annotations.Beta;
023import org.sonar.api.batch.fs.InputFile;
024
025/**
026 * This builder is used to define code coverage by tests of a given type (UT/IT/Overall) on files.
027 * @since 5.2
028 */
029@Beta
030public interface NewCoverage {
031
032  /**
033   * The covered file.
034   */
035  NewCoverage onFile(InputFile inputFile);
036
037  NewCoverage ofType(CoverageType type);
038
039  /**
040   * Call this method as many time as needed to report coverage hits per line. This method should only be called for executable lines.
041   * @param line Line number (starts at 1).
042   * @param hits Number of time the line was hit.
043   */
044  NewCoverage lineHits(int line, int hits);
045
046  /**
047   * Call this method as many time as needed to report coverage of conditions.
048   * @param line Line number (starts at 1).
049   * @param conditions Number of conditions on this line (should be greater than 1).
050   * @param coveredConditions Number of covered conditions.
051   */
052  NewCoverage conditions(int line, int conditions, int coveredConditions);
053
054  /**
055   * Call this method only once when your are done with defining coverage of the file.
056   */
057  void save();
058}