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