001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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;
021
022import org.sonar.api.batch.AnalysisMode;
023import org.sonar.api.batch.postjob.issue.PostJobIssue;
024import org.sonar.api.config.Settings;
025
026/**
027 * See {@link PostJob#execute(PostJobContext)}
028 * @since 5.2
029 */
030public interface PostJobContext {
031
032  /**
033   * Get settings of the current project.
034   */
035  Settings settings();
036
037  AnalysisMode analysisMode();
038
039  // ----------- Only available in preview mode --------------
040
041  /**
042   * All the unresolved issues of the project, including the issues reported by end-users. Only available in preview/issues mode.
043   * @throw {@link UnsupportedOperationException} if not in preview/issues mode. To test the mode you can use {@link #analysisMode()}.
044   */
045  Iterable<PostJobIssue> issues();
046
047  /**
048   * All the issues of this project that have been marked as resolved during this scan. Only available in preview/issues mode.
049   * @throw {@link UnsupportedOperationException} if not in preview mode. To test the mode you can use {@link #analysisMode()}.
050   */
051  Iterable<PostJobIssue> resolvedIssues();
052
053}