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