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.batch.sensor.issue; 021 022import com.google.common.annotations.Beta; 023import org.sonar.api.batch.fs.InputPath; 024import org.sonar.api.batch.sensor.Sensor; 025import org.sonar.api.rule.RuleKey; 026 027import javax.annotation.CheckForNull; 028 029/** 030 * Represents an issue detected by a {@link Sensor}. 031 * 032 * @since 5.1 033 */ 034@Beta 035public interface Issue { 036 037 public enum Severity { 038 INFO, 039 MINOR, 040 MAJOR, 041 CRITICAL, 042 BLOCKER; 043 } 044 045 /** 046 * The {@link RuleKey} of this issue. 047 */ 048 RuleKey ruleKey(); 049 050 /** 051 * The {@link InputPath} this issue belongs to. Returns null if issue is global to the project. 052 */ 053 @CheckForNull 054 InputPath inputPath(); 055 056 /** 057 * Line of the issue. Null for global issues and issues on directories. Can also be null 058 * for files (issue global to the file). 059 */ 060 @CheckForNull 061 Integer line(); 062 063 /** 064 * Effort to fix the issue. Used by technical debt model. 065 */ 066 @CheckForNull 067 Double effortToFix(); 068 069 /** 070 * Message of the issue. 071 */ 072 @CheckForNull 073 String message(); 074 075 /** 076 * Overriden severity. 077 */ 078 @CheckForNull 079 Severity overridenSeverity(); 080 081}