1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2013 - 2023, Tapio Rautonen
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package org.eluder.coveralls.maven.plugin;
25
26 import java.io.File;
27 import java.io.IOException;
28
29 import org.eluder.coveralls.maven.plugin.source.SourceCallback;
30
31
32 /**
33 * Handles parsing of a coverage report. The implemenation can be statefull, and the same instance
34 * should be used only one time to parse a coverage report. Completed source files are passed to
35 * the {@link org.eluder.coveralls.maven.plugin.source.SourceCallback} handler. To maximize performance, the parser should use streaming.
36 */
37 public interface CoverageParser {
38
39 /**
40 * Parses a coverage report. Parsed source files are passed to the callback handler. This
41 * method should be called only once per instance.
42 *
43 * @param callback the source callback handler
44 * @throws ProcessingException if processing of the coverage report fails
45 * @throws IOException if an I/O error occurs
46 */
47 void parse(SourceCallback callback) throws ProcessingException, IOException;
48
49 /**
50 * Gets the coverage file.
51 *
52 * @return the coverage report file under processing
53 */
54 File getCoverageFile();
55 }