org.sonar.api.batch.sensor.measure.MeasureBuilder Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.batch.sensor.measure;

import com.google.common.annotations.Beta;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.measure.Metric;

import java.io.Serializable;

/**
 * Builder to create new {@link Measure}
 * @since 4.4
 */
@Beta
public interface MeasureBuilder {

  /**
   * The file the measure belongs to.
   */
  MeasureBuilder onFile(InputFile file);

  /**
   * Tell that the measure is global to the project.
   */
  MeasureBuilder onProject();

  /**
   * The metric this measure belong to.
   */
  MeasureBuilder forMetric(Metric metric);

  /**
   * Value of the measure.
   */
  MeasureBuilder withValue(G value);

  /**
   * Build the measure. After call of this method the builder is cleaned and can be used to build another measure.
   */
  Measure build();
}