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 * @throws RatException on error. 34 * @see #report(Document) 35 */ 36 void startReport() throws RatException; 37 38 /** 39 * Performs the actual reporting on the given document. 40 * @param document write any reporting results into this document upon analysis. 41 * @throws RatException on error. 42 */ 43 void report(Document document) throws RatException; 44 45 /** 46 * Signals the end of execution for the report. Will be called after the {@code report()} method 47 * to ensure proper cleanup. 48 * @throws RatException on error. 49 * @see #report(Document) 50 */ 51 void endReport() throws RatException; 52 }