1 package org.apache.maven.doxia.docrenderer.pdf;
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
24 import org.apache.maven.doxia.docrenderer.DocumentRenderer;
25 import org.apache.maven.doxia.docrenderer.DocumentRendererException;
26
27 /**
28 * PDF renderer interface.
29 *
30 * @author ltheussl
31 * @version $Id: PdfRenderer.java 746998 2009-02-23 12:52:18Z vsiveton $
32 * @since 1.1
33 */
34 public interface PdfRenderer extends DocumentRenderer
35 {
36 /** Plexus lookup role. */
37 String ROLE = PdfRenderer.class.getName();
38
39 /**
40 * Generate a final pdf ouput file from an intermediate format file.
41 *
42 * @param inputFile eg a fo or an itext file.
43 * @param pdfFile the pdf file to generate.
44 * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.
45 */
46 void generatePdf( File inputFile, File pdfFile )
47 throws DocumentRendererException;
48 }