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