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