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.postjob.issue;
021
022import com.google.common.annotations.Beta;
023import javax.annotation.CheckForNull;
024import org.sonar.api.batch.fs.InputComponent;
025import org.sonar.api.batch.rule.Severity;
026import org.sonar.api.rule.RuleKey;
027
028/**
029 * Represents an issue state at the end of the batch analysis. Only available after local issue tracking in preview mode.
030 *
031 * @since 5.2
032 */
033@Beta
034public interface Issue {
035
036  /**
037   * Key of the issue.
038   */
039  String key();
040
041  /**
042   * The {@link RuleKey} of this issue.
043   */
044  RuleKey ruleKey();
045
046  /**
047   * Component key like foo:src/Foo.php
048   */
049  String componentKey();
050
051  /**
052   * The {@link InputComponent} this issue belongs to. Returns null if component was deleted (for resolved issues).
053   */
054  @CheckForNull
055  InputComponent inputComponent();
056
057  /**
058   * Line of the issue. Null for global issues and issues on directories. Can also be null
059   * for files (issue global to the file).
060   */
061  @CheckForNull
062  Integer line();
063
064  /**
065   * Effort to fix the issue. Used by technical debt model.
066   */
067  @CheckForNull
068  Double effortToFix();
069
070  /**
071   * Message of the issue.
072   */
073  @CheckForNull
074  String message();
075
076  /**
077   * Severity.
078   */
079  Severity severity();
080
081  /**
082   * If the issue a new one.
083   */
084  boolean isNew();
085
086}