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.measure; 021 022import java.io.Serializable; 023import org.sonar.api.batch.fs.InputComponent; 024import org.sonar.api.batch.measure.Metric; 025import org.sonar.api.batch.measure.MetricFinder; 026 027/** 028 * Builder to create new Measure. 029 * Should not be implemented by client. 030 * @since 5.2 031 */ 032public interface NewMeasure<G extends Serializable> { 033 034 /** 035 * The {@link InputComponent} the measure belongs to. Mandatory. 036 */ 037 NewMeasure<G> on(InputComponent component); 038 039 /** 040 * Set the metric this measure belong to. To find a metric based on its key you can use {@link MetricFinder}. 041 */ 042 NewMeasure<G> forMetric(Metric<G> metric); 043 044 /** 045 * Value of the measure. 046 */ 047 NewMeasure<G> withValue(G value); 048 049 /** 050 * Save the measure. It is not permitted so save several measures of the same metric on the same file/project. 051 */ 052 void save(); 053 054}