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
021package org.sonar.api.ce.measure;
022
023import javax.annotation.CheckForNull;
024import org.sonar.api.rule.RuleKey;
025import org.sonar.api.utils.Duration;
026
027/**
028 * Issue that can be used in a {@link MeasureComputer}
029 *
030 * @since 5.2
031 */
032public interface Issue {
033
034  String key();
035
036  RuleKey ruleKey();
037
038  /**
039   * Available list of status can be found in {@link org.sonar.api.issue.Issue#STATUSES}
040   */
041  String status();
042
043  /**
044   * Available list of resolutions can be found in {@link org.sonar.api.issue.Issue#RESOLUTIONS}
045   */
046  @CheckForNull
047  String resolution();
048
049  /**
050   * See constants in {@link org.sonar.api.rule.Severity}.
051   */
052  String severity();
053
054  @CheckForNull
055  Duration debt();
056
057}