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.InputDir;
024import org.sonar.api.batch.fs.InputFile;
025import org.sonar.api.rule.RuleKey;
026import org.sonar.api.rule.Severity;
027
028import javax.annotation.Nullable;
029
030/**
031 * Builder for {@link Issue}.
032 *
033 * @since 4.4
034 */
035@Beta
036public interface IssueBuilder {
037
038  /**
039   * The {@link RuleKey} of the issue.
040   */
041  IssueBuilder ruleKey(RuleKey ruleKey);
042
043  /**
044   * The {@link InputFile} the issue belongs to. For global issues call {@link #onProject()}.
045   */
046  IssueBuilder onFile(InputFile file);
047
048  /**
049   * The {@link InputDir} the issue belongs to. For global issues call {@link #onProject()}.
050   */
051  IssueBuilder onDir(InputDir inputDir);
052
053  /**
054   * Tell that the issue is global to the project.
055   */
056  IssueBuilder onProject();
057
058  /**
059   * Line of the issue. Only available for {@link #onFile(InputFile)} issues. 
060   * If no line is specified it means that issue is global to the file.
061   */
062  IssueBuilder atLine(int line);
063
064  /**
065   * Effort to fix the issue.
066   */
067  IssueBuilder effortToFix(@Nullable Double effortToFix);
068
069  /**
070   * Message of the issue.
071   */
072  IssueBuilder message(String message);
073
074  /**
075   * Severity of the issue. See {@link Severity}.
076   * Setting a null value means to use severity configured in quality profile.
077   */
078  IssueBuilder severity(@Nullable String severity);
079
080  /**
081   * Build the issue. After call of this method the builder is cleaned and can be used to build another issue.
082   */
083  Issue build();
084
085}