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.fs.InputFile;
024    import org.sonar.api.rule.RuleKey;
025    
026    import javax.annotation.Nullable;
027    
028    /**
029     * Builder for {@link AnalyzerIssue}.
030     *
031     * @since 4.4
032     */
033    @Beta
034    public interface AnalyzerIssueBuilder {
035    
036      /**
037       * The {@link RuleKey} of the issue.
038       */
039      AnalyzerIssueBuilder ruleKey(RuleKey ruleKey);
040    
041      /**
042       * The {@link InputFile} the issue belongs to. For global issues call {@link #onProject()}.
043       */
044      AnalyzerIssueBuilder onFile(InputFile file);
045    
046      /**
047       * Tell that the issue is global to the project.
048       */
049      AnalyzerIssueBuilder onProject();
050    
051      /**
052       * Line of the issue. If no line is specified then issue is supposed to be global to the file.
053       */
054      AnalyzerIssueBuilder atLine(int line);
055    
056      /**
057       * Effort to fix the issue.
058       */
059      AnalyzerIssueBuilder effortToFix(@Nullable Double effortToFix);
060    
061      /**
062       * Message of the issue.
063       */
064      AnalyzerIssueBuilder message(String message);
065    
066      /**
067       * Build the issue.
068       */
069      AnalyzerIssue build();
070    
071    }