3 * Copyright (C) 2009-2016 SonarSource SA
4 * mailto:contact AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.server.computation.task.projectanalysis.batch;
22 import com.google.common.base.Optional;
23 import javax.annotation.CheckForNull;
24 import org.sonar.core.util.CloseableIterator;
25 import org.sonar.scanner.protocol.output.ScannerReport;
27 public interface BatchReportReader {
28 ScannerReport.Metadata readMetadata();
30 CloseableIterator<String> readScannerLogs();
32 CloseableIterator<ScannerReport.ActiveRule> readActiveRules();
34 CloseableIterator<ScannerReport.Measure> readComponentMeasures(int componentRef);
37 ScannerReport.Changesets readChangesets(int componentRef);
39 ScannerReport.Component readComponent(int componentRef);
41 CloseableIterator<ScannerReport.Issue> readComponentIssues(int componentRef);
43 CloseableIterator<ScannerReport.Duplication> readComponentDuplications(int componentRef);
45 CloseableIterator<ScannerReport.CpdTextBlock> readCpdTextBlocks(int componentRef);
47 CloseableIterator<ScannerReport.Symbol> readComponentSymbols(int componentRef);
49 CloseableIterator<ScannerReport.SyntaxHighlightingRule> readComponentSyntaxHighlighting(int fileRef);
51 CloseableIterator<ScannerReport.LineCoverage> readComponentCoverage(int fileRef);
54 * Reads file source line by line. Return an absent optional if the file doest not exist
56 Optional<CloseableIterator<String>> readFileSource(int fileRef);
58 CloseableIterator<ScannerReport.Test> readTests(int testFileRef);
60 CloseableIterator<ScannerReport.CoverageDetail> readCoverageDetails(int testFileRef);