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 org.sonar.api.batch.fs.InputFile;
023    import org.sonar.api.batch.measure.Metric;
024    
025    import javax.annotation.CheckForNull;
026    
027    import java.io.Serializable;
028    
029    /**
030     * Builder to create new Measure.
031     * @since 5.0
032     */
033    public interface Measure<G extends Serializable> {
034    
035      /**
036       * The file the measure belongs to.
037       */
038      Measure<G> onFile(InputFile file);
039    
040      /**
041       * Tell that the measure is global to the project.
042       */
043      Measure<G> onProject();
044    
045      /**
046       * The file the measure belong to.
047       * @return null if measure is on project
048       */
049      @CheckForNull
050      InputFile inputFile();
051    
052      /**
053       * Set the metric this measure belong to.
054       */
055      Measure<G> forMetric(Metric<G> metric);
056    
057      /**
058       * The metric this measure belong to.
059       */
060      Metric<G> metric();
061    
062      /**
063       * Value of the measure.
064       */
065      Measure<G> withValue(G value);
066    
067      /**
068       * Value of the measure.
069       */
070      G value();
071    
072      /**
073       * Save the measure. It is not permitted so save several measures of the same metric on the same file/project.
074       */
075      void save();
076    
077    }