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