001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 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.issue;
021
022import org.sonar.api.BatchComponent;
023import org.sonar.api.batch.InstantiationStrategy;
024import org.sonar.api.batch.PostJob;
025
026import static org.sonar.api.batch.InstantiationStrategy.PER_BATCH;
027
028/**
029 * Used by batch components to get the issues of the project. You have to wait for all
030 * issues to have been computed (for example in a {@link PostJob}) to be sure all issues have
031 * been computed.
032 *
033 * @since 4.0
034 */
035@InstantiationStrategy(PER_BATCH)
036public interface ProjectIssues extends BatchComponent {
037
038  /**
039   * All the unresolved issues of the project, including the issues reported by end-users.
040   */
041  Iterable<Issue> issues();
042
043  /**
044   * All the issues of this project that have been marked as resolved during this scan
045   */
046  Iterable<Issue> resolvedIssues();
047}