org.sonar.api.batch.postjob.PostJobContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 9.4.0.54424

/*
 * SonarQube
 * Copyright (C) 2009-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.batch.postjob;

import org.sonar.api.batch.AnalysisMode;
import org.sonar.api.batch.postjob.issue.PostJobIssue;
import org.sonar.api.config.Configuration;

/**
 * See {@link PostJob#execute(PostJobContext)}
 * @since 5.2
 */
public interface PostJobContext {

  /**
   * Get configuration of the current project.
   * @since 6.5
   */
  Configuration config();

  /**
   * @deprecated since 7.3 preview mode deprecated since 6.6
   */
  @Deprecated
  AnalysisMode analysisMode();

  // ----------- Only available in preview mode --------------

  /**
   * All the unresolved issues of the project, including the issues reported by end-users. Only available in preview/issues mode.
   * @throw {@link UnsupportedOperationException} if not in preview/issues mode. To test the mode you can use {@link #analysisMode()}.
   * @deprecated since 7.3 the preview/issues mode is deprecated since 6.7
   */
  @Deprecated
  Iterable issues();

  /**
   * All the issues of this project that have been marked as resolved during this scan. Only available in preview/issues mode.
   * @throw {@link UnsupportedOperationException} if not in preview mode. To test the mode you can use {@link #analysisMode()}.
   * @deprecated since 7.3 the preview/issues mode is deprecated since 6.7
   */
  @Deprecated
  Iterable resolvedIssues();

}