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 package org.sonar.api.batch.analyzer.issue; 021 022 import com.google.common.annotations.Beta; 023 import org.sonar.api.batch.analyzer.Analyzer; 024 import org.sonar.api.batch.fs.InputFile; 025 import org.sonar.api.rule.RuleKey; 026 027 import javax.annotation.Nullable; 028 029 /** 030 * Issue reported by an {@link Analyzer} 031 * 032 * @since 4.4 033 */ 034 @Beta 035 public interface AnalyzerIssue { 036 037 /** 038 * The {@link InputFile} this issue belongs to. Returns null if issue is global to the project. 039 */ 040 @Nullable 041 InputFile inputFile(); 042 043 /** 044 * The {@link RuleKey} of this issue. 045 */ 046 RuleKey ruleKey(); 047 048 /** 049 * Message of the issue. 050 */ 051 String message(); 052 053 /** 054 * Line of the issue. 055 */ 056 Integer line(); 057 058 /** 059 * Effort to fix the issue. Used by technical debt model. 060 */ 061 @Nullable 062 Double effortToFix(); 063 064 }