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.RatException;
22 import org.apache.rat.document.DocumentName;
23
24 public interface IReportable {
25 /**
26 * Adds the reportable to the RatReport.
27 * @param report the report to add the results to.
28 * @throws RatException on error.
29 */
30 void run(RatReport report) throws RatException;
31
32 /**
33 * Returns the DocumentName for the reportable.
34 * @return the DocumentName for the reportable.
35 */
36 DocumentName getName();
37 }