View Javadoc

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  import org.apache.maven.doxia.sink.Sink;
23  import org.apache.maven.doxia.sink.SinkFactory;
24  
25  import java.util.Locale;
26  
27  /**
28   * Interface created separately for backwards compatibility. This method
29   * would ideally have been added in the {@link MavenReport} interface, and the other 'generate'
30   * method dropped. But that would have rendered all reporting mojo's uncompilable and binary incompatible.
31   *
32   * @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
33   * @see MavenReport#generate(org.codehaus.doxia.sink.Sink, Locale)
34   * @since 3.0 (copied in maven-site-plugin 2.0-beta-6)
35   */
36  public interface MavenMultiPageReport
37      extends MavenReport
38  {
39      void generate( Sink sink, SinkFactory sinkFactory, Locale locale )
40          throws MavenReportException;
41  }