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    import org.sonar.api.batch.sensor.Sensor;
026    
027    import javax.annotation.CheckForNull;
028    
029    import java.io.Serializable;
030    
031    /**
032     * A measure computed by an {@link Sensor}.
033     * @since 4.4
034     */
035    @Beta
036    public interface Measure<G extends Serializable> {
037    
038      /**
039       * The {@link InputFile} this measure belongs to. Returns null if measure is global to the project.
040       */
041      @CheckForNull
042      InputFile inputFile();
043    
044      Metric<G> metric();
045    
046      G value();
047    
048    }