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.source;
26
27 import java.io.IOException;
28
29 import org.eluder.coveralls.maven.plugin.ProcessingException;
30 import org.eluder.coveralls.maven.plugin.domain.Source;
31
32 /**
33 * Source callback handles parsed source files from coverage reports.
34 */
35 public interface SourceCallback {
36
37 /**
38 * Called before source parsing has started.
39 *
40 * @throws ProcessingException
41 * if processing fails
42 * @throws IOException
43 * if an I/O error occurs
44 */
45 void onBegin() throws ProcessingException, IOException;
46
47 /**
48 * Handles a parsed source file.
49 *
50 * @param source
51 * the source file
52 *
53 * @throws ProcessingException
54 * if further processing of the source fails
55 * @throws IOException
56 * if an I/O error occurs
57 */
58 void onSource(Source source) throws ProcessingException, IOException;
59
60 /**
61 * Called after all sources are handled.
62 *
63 * @throws ProcessingException
64 * if processing fails
65 * @throws IOException
66 * if an I/O error occurs
67 */
68 void onComplete() throws ProcessingException, IOException;
69
70 }