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     */
020    package org.sonar.api.batch.sensor.measure;
021    
022    import com.google.common.annotations.Beta;
023    import org.sonar.api.batch.fs.InputFile;
024    import org.sonar.api.batch.measure.Metric;
025    
026    import java.io.Serializable;
027    
028    /**
029     * Builder to create new {@link Measure}
030     * @since 4.4
031     */
032    @Beta
033    public interface MeasureBuilder<G extends Serializable> {
034    
035      /**
036       * The file the measure belongs to.
037       */
038      MeasureBuilder<G> onFile(InputFile file);
039    
040      /**
041       * Tell that the measure is global to the project.
042       */
043      MeasureBuilder<G> onProject();
044    
045      /**
046       * The metric this measure belong to.
047       */
048      MeasureBuilder<G> forMetric(Metric<G> metric);
049    
050      /**
051       * Value of the measure.
052       */
053      MeasureBuilder<G> withValue(G value);
054    
055      /**
056       * Build the measure. After call of this method the builder is cleaned and can be used to build another measure.
057       */
058      Measure<G> build();
059    }