001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program 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 * This program 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.batch.sensor.issue;
021
022import com.google.common.annotations.Beta;
023import java.util.List;
024import javax.annotation.CheckForNull;
025import org.sonar.api.batch.rule.Severity;
026import org.sonar.api.batch.sensor.Sensor;
027import org.sonar.api.rule.RuleKey;
028
029/**
030 * Represents an issue detected by a {@link Sensor}.
031 *
032 * @since 5.1
033 */
034@Beta
035public interface Issue {
036
037  interface Flow {
038    /**
039     * @return Ordered list of locations for the execution flow
040     */
041    List<IssueLocation> locations();
042  }
043
044  /**
045   * The {@link RuleKey} of this issue.
046   */
047  RuleKey ruleKey();
048
049  /**
050   * Effort to fix the issue. Used by technical debt model.
051   * @deprecated since 5.5 use {@link #gap()}
052   */
053  @CheckForNull
054  @Deprecated
055  Double effortToFix();
056
057  /**
058   * Gap used to compute the effort for fixing the issue.
059   * @since 5.5
060   */
061  @CheckForNull
062  Double gap();
063
064  /**
065   * Overridden severity.
066   */
067  @CheckForNull
068  Severity overriddenSeverity();
069
070  /**
071   * Primary locations for this issue.
072   * @since 5.2
073   */
074  IssueLocation primaryLocation();
075
076  /**
077   * List of flows for this issue. Can be empty.
078   * @since 5.2
079   */
080  List<Flow> flows();
081
082}