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.measures;
021    
022    /**
023     * Provides facility to store measures for the lines of file.
024     * Examples:
025     * <ul>
026     * <li>line 1 is a line of code</li>
027     * <li>line 2 contains comment</li>
028     * <li>line 3 contains 2 branches</li>
029     * <li>author of line 4 is Simon</li>
030     * </ul>
031     * Numbering of lines starts from 1.
032     * Also note that you can't update what already was saved, however it is safe to call {@link #save()} several times.
033     * <p>
034     * Instances of this interface can be obtained using {@link FileLinesContextFactory}.
035     * <p/>
036     * This interface is not intended to be implemented by clients.
037     *
038     * @since 2.14
039     */
040    public interface FileLinesContext {
041    
042      /**
043       * @throws UnsupportedOperationException on attempt to update already saved data
044       */
045      void setIntValue(String metricKey, int line, int value);
046    
047      /**
048       * @return value, or null if no such metric for given line
049       * @deprecated since 5.0 sensors should not read data
050       */
051      @Deprecated
052      Integer getIntValue(String metricKey, int line);
053    
054      /**
055       * @throws UnsupportedOperationException on attempt to update already saved data
056       */
057      void setStringValue(String metricKey, int line, String value);
058    
059      /**
060       * @return value, or null if no such metric for given line
061       * @deprecated since 5.0 sensors should not read data
062       */
063      @Deprecated
064      String getStringValue(String metricKey, int line);
065    
066      /**
067       * Saves unsaved values.
068       */
069      void save();
070    
071    }