1 package org.apache.maven.reporting;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * Basis for rendering report.
24 *
25 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
26 * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
27 * @since 2.0
28 * TODO Later it may be appropriate to create something like a VelocityMavenReportRenderer
29 * that could take a velocity template and pipe that through Doxia rather than coding
30 * them up like this.
31 */
32 public interface MavenReportRenderer
33 {
34 /**
35 * @return the wanted report's title.
36 */
37 String getTitle();
38
39 /**
40 * Renderer a report.
41 */
42 void render();
43 }