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