1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.report;
20
21 import org.apache.rat.api.Document;
22 import org.apache.rat.api.RatException;
23
24 /**
25 * Interface that defines a RatReport.
26 * A RatReport examines a document and may report issues or modify the underlying file.
27 */
28 public interface RatReport {
29
30 /**
31 * Signals the start of execution for the report. Will be called before the {@code report()} method
32 * to ensure proper setup.
33 * Default implementation does nothing.
34 * @throws RatException on error.
35 * @see #report(Document)
36 */
37 default void startReport() throws RatException {
38 }
39
40 /**
41 * Performs the actual reporting on the given document.
42 * Default implementation does nothing.
43 * @param document write any reporting results into this document upon analysis.
44 * @throws RatException on error.
45 */
46 default void report(Document document) throws RatException {
47 }
48
49 /**
50 * Signals the end of execution for the report. Will be called after the {@code report()} method
51 * to ensure proper cleanup.
52 * Default implementation does nothing.
53 * @throws RatException on error.
54 * @see #report(Document)
55 */
56 default void endReport() throws RatException {
57 }
58 }