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 handler that allows chaining multiple callback handlers. Chained callback
33 * handler is executed after this callback.
34 */
35 public abstract class ChainingSourceCallback implements SourceCallback {
36
37 private final SourceCallback chained;
38
39 public ChainingSourceCallback(final SourceCallback chained) {
40 if (chained == null) {
41 throw new IllegalArgumentException("chained must be defined");
42 }
43 this.chained = chained;
44 }
45
46 @Override
47 public final void onBegin() throws ProcessingException, IOException {
48 onBeginInternal();
49 chained.onBegin();
50 }
51
52 @Override
53 public final void onSource(final Source source) throws ProcessingException, IOException {
54 onSourceInternal(source);
55 chained.onSource(source);
56 }
57
58 @Override
59 public final void onComplete() throws ProcessingException, IOException {
60 onCompleteInternal();
61 chained.onComplete();
62 }
63
64 /**
65 * Defaults to no-op implementation.
66 *
67 * @see #onBegin()
68 *
69 * @throws ProcessingException if processing fails
70 * @throws IOException if an I/O error occurs
71 */
72 protected void onBeginInternal() throws ProcessingException, IOException {
73
74 }
75
76 /**
77 * On source internal.
78 *
79 * @param source the source file
80 * @throws ProcessingException if further processing of the source fails
81 * @throws IOException if an I/O error occurs
82 * @see #onSource(Source)
83 */
84 protected abstract void onSourceInternal(final Source source) throws ProcessingException, IOException;
85
86 /**
87 * Defaults to no-op implementation.
88 *
89 * @see #onComplete()
90 *
91 * @throws ProcessingException if processing fails
92 * @throws IOException if an I/O error occurs
93 */
94 protected void onCompleteInternal() throws ProcessingException, IOException {
95
96 }
97 }