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.measure;
021
022import com.google.common.annotations.Beta;
023import org.sonar.api.batch.fs.InputFile;
024import org.sonar.api.batch.measure.Metric;
025
026import java.io.Serializable;
027
028/**
029 * Builder to create new Measure.
030 * Should not be implemented by client.
031 * @since 5.1
032 */
033@Beta
034public interface NewMeasure<G extends Serializable> {
035
036  /**
037   * The file the measure belongs to.
038   */
039  NewMeasure<G> onFile(InputFile file);
040
041  /**
042   * Tell that the measure is global to the project.
043   */
044  NewMeasure<G> onProject();
045
046  /**
047   * Set the metric this measure belong to.
048   */
049  NewMeasure<G> forMetric(Metric<G> metric);
050
051  /**
052   * Value of the measure.
053   */
054  NewMeasure<G> withValue(G value);
055
056  /**
057   * Save the measure. It is not permitted so save several measures of the same metric on the same file/project.
058   */
059  void save();
060
061}