View Javadoc
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.maven.reporting;
20  
21  /**
22   * Basis for rendering report.
23   *
24   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
25   * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
26   * @since 2.0
27   */
28  public interface MavenReportRenderer {
29      /**
30       * @return the wanted report's title.
31       */
32      String getTitle();
33  
34      /**
35       * Renderer a report.
36       * @throws MavenReportException if any
37       */
38      void render() throws MavenReportException;
39  }