1 package org.apache.maven.doxia.docrenderer;
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 java.io.File;
23 import java.io.IOException;
24
25 /**
26 * Base renderer interface for the <code>document</code>
27 *
28 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
29 * @deprecated Since 1.1, use {@link DocumentRenderer} instead.
30 */
31 public interface DocRenderer
32 {
33 /** Plexus lookup. */
34 String ROLE = DocRenderer.class.getName();
35
36 /**
37 * Render all files from a site directory to an output directory
38 *
39 * @param siteDirectory the input directory contains files to be generated
40 * @param outputDirectory the output directory where files are generated
41 * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
42 * @throws java.io.IOException if any
43 */
44 void render( File siteDirectory, File outputDirectory )
45 throws DocumentRendererException, IOException;
46
47 /**
48 * Render a document depending a context and a document descriptor
49 *
50 * @param siteDirectory the input directory contains files to be generated
51 * @param outputDirectory the output directory where file are generated
52 * @param documentDescriptor the document descriptor
53 * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
54 * @throws java.io.IOException if any
55 */
56 void render( File siteDirectory, File outputDirectory, File documentDescriptor )
57 throws DocumentRendererException, IOException;
58
59 /**
60 * Get the output extension supported
61 *
62 * @return the ouput extension supported
63 */
64 String getOutputExtension();
65 }