org.apache.maven.doxia.docrenderer.pdf.PdfRenderer Maven / Gradle / Ivy

Go to download
package org.apache.maven.doxia.docrenderer.pdf;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.File;

import org.apache.maven.doxia.docrenderer.DocumentRenderer;
import org.apache.maven.doxia.docrenderer.DocumentRendererException;

/**
 * PDF renderer interface.
 *
 * @author ltheussl
 * @since 1.1
 */
public interface PdfRenderer
    extends DocumentRenderer
{
    /** Plexus lookup role. */
    String ROLE = PdfRenderer.class.getName();

   /**
    * Generate a final pdf ouput file from an intermediate format file.
    *
     * @param inputFile eg a fo or an itext file.
     * @param pdfFile the pdf file to generate.
     * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.
    */
   void generatePdf( File inputFile, File pdfFile )
        throws DocumentRendererException;
}